WireCommon (OpenHFT/Chronicle-Wire 2.24ea27 API)

All Known Subinterfaces:

Wire, WireIn, WireOut

All Known Implementing Classes:

AbstractAnyWire, AbstractWire, BinaryWire, CSVWire, HashWire, JSONWire, QueryWire, RawWire, ReadAnyWire, TextWire, YamlWire, YamlWireOut
```
public interface WireCommon
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`@NotNull net.openhft.chronicle.bytes.Bytes<?>`	`bytes()` Returns the underlying `Bytes` stored by the wire.
`net.openhft.chronicle.bytes.HexDumpBytesDescription<?>`	`bytesComment()` Returns the bytes() but only for comment.
`net.openhft.chronicle.core.pool.ClassLookup`	`classLookup()` Returns the current `ClassLookup` implementation being used for class lookup.
`void`	`classLookup(net.openhft.chronicle.core.pool.ClassLookup classLookup)` Sets the `ClassLookup` implementation to be used for class lookup.
`void`	`clear()` Resets the state of the underlying `Bytes` stored by the wire.
`long`	`headerNumber()`
`@NotNull WireOut`	`headerNumber(long headerNumber)`
`boolean`	`isBinary()` Determine whether direct access to the underlying byte() makes sense or should it be treated as text
`@NotNull net.openhft.chronicle.core.values.BooleanValue`	`newBooleanReference()` Creates and returns a new `BooleanValue`.
`@NotNull net.openhft.chronicle.core.values.IntArrayValues`	`newIntArrayReference()` Creates and returns a new `IntArrayValues`.
`@NotNull net.openhft.chronicle.core.values.IntValue`	`newIntReference()` Creates and returns a new `IntValue`.
`@NotNull net.openhft.chronicle.core.values.LongArrayValues`	`newLongArrayReference()` Creates and returns a new `LongArrayValues`.
`@NotNull net.openhft.chronicle.core.values.LongValue`	`newLongReference()` Creates and returns a new `LongValue`.
`default @NotNull net.openhft.chronicle.core.values.TwoLongValue`	`newTwoLongReference()` Creates and returns a new `TwoLongValue`.
`default boolean`	`notCompleteIsNotPresent()` If a message is marked as NOT_COMPLETE is it still present.
`default void`	`notCompleteIsNotPresent(boolean notCompleteArePresent)`
`@Nullable Object`	`parent()` Returns the wire parent object.
`void`	`parent(Object parent)` Assigns the wire parent object for later retrieval.
`net.openhft.chronicle.threads.Pauser`	`pauser()` Returns the current `Pauser` implementation being used for blocking operations.
`void`	`pauser(net.openhft.chronicle.threads.Pauser pauser)` Sets the `Pauser` implementation to be used for blocking operations.
`void`	`reset()` Reset the state of the wire
`boolean`	`usePadding()`
`void`	`usePadding(boolean usePadding)`
`boolean`	`useSelfDescribingMessage(@NotNull net.openhft.chronicle.bytes.CommonMarshallable object)` Should this wire write the object as a Marshallable or BytesMarshallable

- Method Detail
  - classLookup
```
void classLookup(net.openhft.chronicle.core.pool.ClassLookup classLookup)
```
    Sets the ClassLookup implementation to be used for class lookup.
    
    Parameters:
    
    classLookup - implementation to be used for class lookup.
  - classLookup
```
net.openhft.chronicle.core.pool.ClassLookup classLookup()
```
    Returns the current ClassLookup implementation being used for class lookup.
    
    Returns:
    
    the current ClassLookup implementation being used for class lookup
  - pauser
```
void pauser(net.openhft.chronicle.threads.Pauser pauser)
```
    Sets the Pauser implementation to be used for blocking operations.
    
    Parameters:
    
    pauser - implementation to be used for blocking operations.
  - pauser
```
net.openhft.chronicle.threads.Pauser pauser()
```
    Returns the current Pauser implementation being used for blocking operations.
    
    Returns:
    
    the current Pauser implementation being used for blocking operations
  - bytes
```
@NotNull
@NotNull net.openhft.chronicle.bytes.Bytes<?> bytes()
```
    Returns the underlying Bytes stored by the wire.
    
    Returns:
    
    the underlying Bytes stored by the wire
  - bytesComment
```
net.openhft.chronicle.bytes.HexDumpBytesDescription<?> bytesComment()
```
    Returns the bytes() but only for comment.
    
    Returns:
    
    the bytes() but only for comment
  - newIntReference
```
@NotNull
@NotNull net.openhft.chronicle.core.values.IntValue newIntReference()
```
    Creates and returns a new IntValue. The IntValue implementation that is returned depends on the wire implementation.
    
    Returns:
    
    a new IntValue.
  - newLongReference
```
@NotNull
@NotNull net.openhft.chronicle.core.values.LongValue newLongReference()
```
    Creates and returns a new LongValue. The LongValue implementation that is returned depends on the wire implementation.
    
    Returns:
    
    a new LongValue
  - newTwoLongReference
```
@NotNull
default @NotNull net.openhft.chronicle.core.values.TwoLongValue newTwoLongReference()
```
    Creates and returns a new TwoLongValue. The TwoLongValue implementation that is returned depends on the wire implementation.
    
    Returns:
    
    a new TwoLongValue
  - newLongArrayReference
```
@NotNull
@NotNull net.openhft.chronicle.core.values.LongArrayValues newLongArrayReference()
```
    Creates and returns a new LongArrayValues. The LongArrayValues implementation that is returned depends on the wire implementation.
    
    Returns:
    
    a new LongArrayValues
  - newIntArrayReference
```
@NotNull
@NotNull net.openhft.chronicle.core.values.IntArrayValues newIntArrayReference()
```
    Creates and returns a new IntArrayValues. The IntArrayValues implementation that is returned depends on the wire implementation.
    
    Returns:
    
    a new IntArrayValues
  - clear
```
void clear()
```
    Resets the state of the underlying Bytes stored by the wire.
  - parent
```
@Nullable
@Nullable Object parent()
```
    Returns the wire parent object. If the parent was not assigned, null is returned instead.
    
    Returns:
    
    the wire parent object or null if none was assigned.
  - parent
```
void parent(Object parent)
```
    Assigns the wire parent object for later retrieval.
    
    Parameters:
    
    parent - to set, or null if there isn't one.
  - notCompleteIsNotPresent
```
default boolean notCompleteIsNotPresent()
```
    If a message is marked as NOT_COMPLETE is it still present.
    
    Returns:
    
    true if NOT_COMPLETE messages can be seen, false if they cannot.
  - notCompleteIsNotPresent
```
default void notCompleteIsNotPresent(boolean notCompleteArePresent)
```
  - headerNumber
```
@NotNull
@NotNull WireOut headerNumber(long headerNumber)
```
  - headerNumber
```
long headerNumber()
```
  - usePadding
```
void usePadding(boolean usePadding)
```
  - usePadding
```
boolean usePadding()
```
  - newBooleanReference
```
@NotNull
@NotNull net.openhft.chronicle.core.values.BooleanValue newBooleanReference()
```
    Creates and returns a new BooleanValue. The BooleanValue implementation that is returned depends on the wire implementation.
    
    Returns:
    
    a new BooleanValue.
  - useSelfDescribingMessage
```
boolean useSelfDescribingMessage(@NotNull
                                 @NotNull net.openhft.chronicle.bytes.CommonMarshallable object)
```
    Should this wire write the object as a Marshallable or BytesMarshallable
    
    Returns:
    
    use Marshallable
  - isBinary
```
boolean isBinary()
```
    Determine whether direct access to the underlying byte() makes sense or should it be treated as text
    
    Returns:
    
    Is this a binary protocol
  - reset
```
void reset()
```
    Reset the state of the wire

Interface WireCommon

Method Summary

Method Detail

classLookup

classLookup

pauser

pauser

bytes

bytesComment

newIntReference

newLongReference

newTwoLongReference

newLongArrayReference

newIntArrayReference

clear

parent

parent

notCompleteIsNotPresent

notCompleteIsNotPresent

headerNumber

headerNumber

usePadding

usePadding

newBooleanReference

useSelfDescribingMessage

isBinary

reset