RawWire (OpenHFT/Chronicle-Wire 2.26ea3 API)

java.lang.Object
- net.openhft.chronicle.wire.AbstractWire
- - net.openhft.chronicle.wire.RawWire

All Implemented Interfaces:

DocumentWritten, MarshallableIn, MarshallableOut, RollbackIfNotCompleteNotifier, Wire, WireCommon, WireIn, WireOut
```
public class RawWire
extends AbstractWire
implements Wire
```
Represents a wire type that focuses on writing pure data, omitting any metadata. The RawWire class is specifically designed for efficient binary serialization where headers and other metadata might not be necessary.

Nested Class Summary
- Nested classes/interfaces inherited from interface net.openhft.chronicle.wire.WireIn
  WireIn.HeaderType
- Nested classes/interfaces inherited from interface net.openhft.chronicle.wire.WireOut
  WireOut.EndOfWire

Field Summary
- Fields inherited from class net.openhft.chronicle.wire.AbstractWire
  bytes, classLookup, commentListener, DEFAULT_USE_PADDING, parent, use8bit
- Fields inherited from interface net.openhft.chronicle.wire.MarshallableIn
  MARSHALLABLE_IN_INTERN_SIZE

Constructor Summary

Constructors
Constructor and Description
`RawWire(@NotNull net.openhft.chronicle.bytes.Bytes<?> bytes)`
`RawWire(@NotNull net.openhft.chronicle.bytes.Bytes<?> bytes, boolean use8bit)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DocumentContext`	`acquireWritingDocument(boolean metaData)` Retrieves a context for writing either data or metadata, reusing an existing context if available.
`@NotNull WireOut`	`addPadding(int paddingToAdd)` Adds padding to the wire.
`@NotNull net.openhft.chronicle.bytes.Bytes<?>`	`bytes()` Returns the underlying `Bytes` stored by the wire.
`void`	`clear()` Clears the WireIn, effectively resetting its state.
`void`	`consumePadding()` Consumes and discards any padding that may exist between the current read position and the next piece of meaningful data.
`void`	`copyTo(@NotNull WireOut wire)` Copies the content from the current WireIn source to the provided WireOut destination.
`@NotNull ValueIn`	`getValueIn()` Obtains the value associated with a field or event for more advanced use cases.
`@NotNull ValueOut`	`getValueOut()` Retrieves the interface for defining the output of a value that will be written to the stream.
`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.bytes.ref.BinaryLongArrayReference`	`newLongArrayReference()` Creates and returns a new `LongArrayValues`.
`@NotNull net.openhft.chronicle.core.values.LongValue`	`newLongReference()` Creates and returns a new `LongValue`.
`@NotNull ValueIn`	`read()` Reads the next field if present, or returns an empty string if not present.
`@NotNull ValueIn`	`read(@NotNull StringBuilder name)` Reads a specific field based on the provided field name.
`@NotNull ValueIn`	`read(@NotNull WireKey key)` Reads the next field if present.
`@NotNull WireIn`	`readAlignTo(int alignment)` Adjusts the read position of the WireIn to align with the specified boundary.
`@NotNull Wire`	`readComment(@NotNull StringBuilder sb)` Reads a comment from the Wire data and appends it to the provided StringBuilder.
`<K> K`	`readEvent(@NotNull Class<K> expectedClass)` Reads a field which may contain an object of any specified type.
`@NotNull ValueIn`	`readEventName(@NotNull StringBuilder name)` Reads a field or string, ensuring the value is always read.
`@NotNull DocumentContext`	`readingDocument()` equivalent to `WireIn.readDocument(net.openhft.chronicle.wire.ReadMarshallable, net.openhft.chronicle.wire.ReadMarshallable)` but with out the use of a lambda expression
`@NotNull DocumentContext`	`readingDocument(long readLocation)` Provides a context for reading a document starting at a specific position.
`@NotNull String`	`readingPeekYaml()` Peeks at the content in the current WireIn instance and returns it as a YAML string.
`void`	`reset()` Reset the state of the wire
`String`	`toString()`
`boolean`	`useSelfDescribingMessage(@NotNull net.openhft.chronicle.bytes.CommonMarshallable object)` Should this wire write the object as a Marshallable or BytesMarshallable
`@NotNull ValueOut`	`write()` Writes an empty field marker to the stream.
`@NotNull ValueOut`	`write(@NotNull CharSequence name)` Writes a CharSequence key to the stream.
`@NotNull ValueOut`	`write(@NotNull WireKey key)` Writes a WireKey to the stream.
`@NotNull Wire`	`writeComment(CharSequence s)` Writes a comment to the wire.
`void`	`writeEndEvent()`
`@NotNull ValueOut`	`writeEventName(@NotNull CharSequence name)` Writes a CharSequence key to the stream.
`@NotNull ValueOut`	`writeEventName(@NotNull WireKey key)` Writes a key to the stream.
`void`	`writeStartEvent()` Start an event object, mostly for internal use.
`@NotNull DocumentContext`	`writingDocument(boolean metaData)` Starts the process of writing a document to the wire with an option for metadata.

Methods inherited from class net.openhft.chronicle.wire.AbstractWire
bytesComment, classLookup, classLookup, commentListener, endOfWire, enterHeader, forceNotInsideHeader, headerNumber, headerNumber, headNumberCheck, isInsideHeader, notCompleteIsNotPresent, notCompleteIsNotPresent, objectInput, objectOutput, parent, parent, pauser, pauser, readAndSetLength, readDataHeader, readEventNumber, readFirstHeader, readFirstHeader, readMetaDataHeader, updateFirstHeader, updateFirstHeader, updateHeader, usePadding, usePadding, writeEndOfWire, writeFirstHeader

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.openhft.chronicle.wire.Wire
headerNumber, newYamlWireOnHeap

Methods inherited from interface net.openhft.chronicle.wire.WireIn
commentListener, endEvent, hasMetaDataPrefix, hasMore, hintReadInputOrder, isEmpty, isEndEvent, isNotEmptyAfterPadding, objectInput, rawReadData, read, readAllAsMap, readAndSetLength, readDataHeader, readDataHeader, readDocument, readDocument, readEventNumber, readFirstHeader, readFirstHeader, readMetaDataHeader, startEvent

Methods inherited from interface net.openhft.chronicle.wire.MarshallableIn
methodReader, methodReaderBuilder, readBytes, readBytes, readDocument, readMap, readText, readText

Methods inherited from interface net.openhft.chronicle.wire.WireOut
dropDefault, endOfWire, enterHeader, objectOutput, padToCacheAlign, updateFirstHeader, updateFirstHeader, updateHeader, writeAlignTo, writeAllAsMap, writeDocument, writeEndOfWire, writeEvent, writeEventId, writeEventId, writeFirstHeader, writeNotCompleteDocument, writingDocument, writingIsComplete

Methods inherited from interface net.openhft.chronicle.wire.WireCommon
bytesComment, classLookup, classLookup, headerNumber, newTwoLongReference, notCompleteIsNotPresent, notCompleteIsNotPresent, parent, parent, pauser, pauser, usePadding, usePadding

Methods inherited from interface net.openhft.chronicle.wire.MarshallableOut
builder, methodWriter, methodWriterBuilder, methodWriterBuilder, recordHistory, writeBytes, writeDocument, writeDocument, writeMap, writeMessage, writeMessage, writeText

Methods inherited from interface net.openhft.chronicle.wire.RollbackIfNotCompleteNotifier
rollbackIfNotComplete

- Constructor Detail
  - RawWire
```
public RawWire(@NotNull
               @NotNull net.openhft.chronicle.bytes.Bytes<?> bytes)
```
  - RawWire
```
public RawWire(@NotNull
               @NotNull net.openhft.chronicle.bytes.Bytes<?> bytes,
               boolean use8bit)
```
- Method Detail
  - reset
```
public void reset()
```
    Description copied from interface: WireCommon
    
    Reset the state of the wire
    
    Specified by:
    
    reset in interface WireCommon
  - isBinary
```
public boolean isBinary()
```
    Description copied from interface: WireCommon
    
    Determine whether direct access to the underlying byte() makes sense or should it be treated as text
    
    Specified by:
    
    isBinary in interface WireCommon
    
    Returns:
    
    Is this a binary protocol
  - writingDocument
```
@NotNull
public @NotNull DocumentContext writingDocument(boolean metaData)
```
    Description copied from interface: WireOut
    
    Starts the process of writing a document to the wire with an option for metadata.
    
    Specified by:
    
    writingDocument in interface DocumentWritten
    
    Specified by:
    
    writingDocument in interface MarshallableOut
    
    Specified by:
    
    writingDocument in interface WireOut
    
    Parameters:
    
    metaData - If true, the returned document context will be used for writing metadata.
    
    Returns:
    
    A context for the document being written.
  - acquireWritingDocument
```
public DocumentContext acquireWritingDocument(boolean metaData)
```
    Description copied from interface: WireOut
    
    Retrieves a context for writing either data or metadata, reusing an existing context if available.
    
    Specified by:
    
    acquireWritingDocument in interface DocumentWritten
    
    Specified by:
    
    acquireWritingDocument in interface MarshallableOut
    
    Specified by:
    
    acquireWritingDocument in interface WireOut
    
    Parameters:
    
    metaData - If true, the returned context will be used for writing metadata.
    
    Returns:
    
    A context for the document being written.
  - readingDocument
```
@NotNull
public @NotNull DocumentContext readingDocument()
```
    Description copied from interface: WireIn
    
    equivalent to WireIn.readDocument(net.openhft.chronicle.wire.ReadMarshallable, net.openhft.chronicle.wire.ReadMarshallable) but with out the use of a lambda expression
    
    Specified by:
    
    readingDocument in interface MarshallableIn
    
    Specified by:
    
    readingDocument in interface WireIn
    
    Returns:
    
    the document context
  - readingDocument
```
@NotNull
public @NotNull DocumentContext readingDocument(long readLocation)
```
    Description copied from interface: WireIn
    
    Provides a context for reading a document starting at a specific position.
    
    Specified by:
    
    readingDocument in interface WireIn
    
    Parameters:
    
    readLocation - The position from which to start reading the document.
    
    Returns:
    
    the document context associated with the specific read location.
  - consumePadding
```
public void consumePadding()
```
    Description copied from interface: WireIn
    
    Consumes and discards any padding that may exist between the current read position and the next piece of meaningful data.
    
    Specified by:
    
    consumePadding in interface WireIn
  - readingPeekYaml
```
@NotNull
public @NotNull String readingPeekYaml()
```
    Description copied from interface: WireIn
    
    Peeks at the content in the current WireIn instance and returns it as a YAML string.
    
    Specified by:
    
    readingPeekYaml in interface WireIn
    
    Returns:
    
    A String containing a YAML representation of the peeked content.
  - copyTo
```
public void copyTo(@NotNull
                   @NotNull WireOut wire)
```
    Description copied from interface: WireIn
    
    Copies the content from the current WireIn source to the provided WireOut destination.
    
    Specified by:
    
    copyTo in interface WireIn
    
    Parameters:
    
    wire - The WireOut instance where the content will be copied to.
  - read
```
@NotNull
public @NotNull ValueIn read()
```
    Description copied from interface: WireIn
    
    Reads the next field if present, or returns an empty string if not present.
    
    Specified by:
    
    read in interface WireIn
    
    Returns:
    
    The value of the next field, encapsulated in a ValueIn instance.
  - read
```
@NotNull
public @NotNull ValueIn read(@NotNull
                                      @NotNull WireKey key)
```
    Description copied from interface: WireIn
    
    Reads the next field if present. The field should match the provided WireKey.
    
    Specified by:
    
    read in interface WireIn
    
    Parameters:
    
    key - The WireKey that should match the next field.
    
    Returns:
    
    The value of the matched field, encapsulated in a ValueIn instance.
  - readEventName
```
@NotNull
public @NotNull ValueIn readEventName(@NotNull
                                               @NotNull StringBuilder name)
```
    Description copied from interface: WireIn
    
    Reads a field or string, ensuring the value is always read. This method is specifically designed to ensure reading even for formats that might potentially omit the field, such as RAW.
    
    Specified by:
    
    readEventName in interface WireIn
    
    Parameters:
    
    name - The StringBuilder that holds the name of the field or string.
    
    Returns:
    
    The value of the field or string, encapsulated in a ValueIn instance.
  - readEvent
```
@Nullable
public <K> K readEvent(@NotNull
                                 @NotNull Class<K> expectedClass)
                          throws net.openhft.chronicle.core.io.InvalidMarshallableException
```
    Description copied from interface: WireIn
    
    Reads a field which may contain an object of any specified type.
    
    Specified by:
    
    readEvent in interface WireIn
    
    Type Parameters:
    
    K - The type of object expected.
    
    Parameters:
    
    expectedClass - The class type hint of the expected object. If no hint is available, use Object.class.
    
    Returns:
    
    An instance of the specified expectedClass.
    
    Throws:
    
    net.openhft.chronicle.core.io.InvalidMarshallableException - If there's an error in the marshalling process.
  - read
```
@NotNull
public @NotNull ValueIn read(@NotNull
                                      @NotNull StringBuilder name)
```
    Description copied from interface: WireIn
    
    Reads a specific field based on the provided field name. If the field is not present, it returns an empty string.
    
    Specified by:
    
    read in interface WireIn
    
    Parameters:
    
    name - The name of the field to read.
    
    Returns:
    
    The value of the specified field, encapsulated in a ValueIn instance.
  - getValueIn
```
@NotNull
public @NotNull ValueIn getValueIn()
```
    Description copied from interface: WireIn
    
    Obtains the value associated with a field or event for more advanced use cases. Typically used after a call to WireIn.readEvent(Class).
    
    Specified by:
    
    getValueIn in interface WireIn
    
    Returns:
    
    The value of the field or event, encapsulated in a ValueIn instance.
  - readComment
```
@NotNull
public @NotNull Wire readComment(@NotNull
                                          @NotNull StringBuilder sb)
```
    Description copied from interface: WireIn
    
    Reads a comment from the Wire data and appends it to the provided StringBuilder.
    
    Specified by:
    
    readComment in interface WireIn
    
    Parameters:
    
    sb - StringBuilder to which the comment will be appended.
    
    Returns:
    
    the WireIn instance for method chaining.
  - clear
```
public void clear()
```
    Description copied from interface: WireIn
    
    Clears the WireIn, effectively resetting its state.
    
    Specified by:
    
    clear in interface WireCommon
    
    Specified by:
    
    clear in interface WireIn
    
    Specified by:
    
    clear in interface WireOut
    
    Overrides:
    
    clear in class AbstractWire
  - newBooleanReference
```
@NotNull
public @NotNull net.openhft.chronicle.core.values.BooleanValue newBooleanReference()
```
    Description copied from interface: WireCommon
    
    Creates and returns a new BooleanValue. The BooleanValue implementation that is returned depends on the wire implementation.
    
    Specified by:
    
    newBooleanReference in interface WireCommon
    
    Returns:
    
    a new BooleanValue.
  - useSelfDescribingMessage
```
public boolean useSelfDescribingMessage(@NotNull
                                        @NotNull net.openhft.chronicle.bytes.CommonMarshallable object)
```
    Description copied from interface: WireCommon
    
    Should this wire write the object as a Marshallable or BytesMarshallable
    
    Specified by:
    
    useSelfDescribingMessage in interface WireCommon
    
    Returns:
    
    use Marshallable
  - bytes
```
@NotNull
public @NotNull net.openhft.chronicle.bytes.Bytes<?> bytes()
```
    Description copied from interface: WireCommon
    
    Returns the underlying Bytes stored by the wire.
    
    Specified by:
    
    bytes in interface WireCommon
    
    Overrides:
    
    bytes in class AbstractWire
    
    Returns:
    
    the underlying Bytes stored by the wire
  - readAlignTo
```
@NotNull
public @NotNull WireIn readAlignTo(int alignment)
```
    Description copied from interface: WireIn
    
    Adjusts the read position of the WireIn to align with the specified boundary. Typically used for cases where data is structured in blocks of fixed sizes, ensuring proper alignment.
    
    Specified by:
    
    readAlignTo in interface WireIn
    
    Parameters:
    
    alignment - The byte boundary to which the read position should align.
    
    Returns:
    
    the WireIn instance for method chaining.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - write
```
@NotNull
public @NotNull ValueOut write()
```
    Description copied from interface: WireOut
    
    Writes an empty field marker to the stream.
    
    Specified by:
    
    write in interface WireOut
    
    Returns:
    
    An interface to further define the output for the written value.
  - writeEventName
```
@NotNull
public @NotNull ValueOut writeEventName(@NotNull
                                                 @NotNull WireKey key)
```
    Description copied from interface: WireOut
    
    Writes a key to the stream. For RAW types, the label will be in text. This can be read using readEventName().
    
    Specified by:
    
    writeEventName in interface WireOut
    
    Parameters:
    
    key - The key to write to the stream.
    
    Returns:
    
    An interface to further define the output for the written value.
  - writeEventName
```
@NotNull
public @NotNull ValueOut writeEventName(@NotNull
                                                 @NotNull CharSequence name)
```
    Description copied from interface: WireOut
    
    Writes a CharSequence key to the stream.
    
    Specified by:
    
    writeEventName in interface WireOut
    
    Parameters:
    
    name - The CharSequence key to write to the stream.
    
    Returns:
    
    An interface to further define the output for the written value.
  - writeStartEvent
```
public void writeStartEvent()
```
    Description copied from interface: WireOut
    
    Start an event object, mostly for internal use.
    
    Specified by:
    
    writeStartEvent in interface WireOut
  - writeEndEvent
```
public void writeEndEvent()
```
    Specified by:
    
    writeEndEvent in interface WireOut
  - write
```
@NotNull
public @NotNull ValueOut write(@NotNull
                                        @NotNull WireKey key)
```
    Description copied from interface: WireOut
    
    Writes a WireKey to the stream. This method is typically used for wires that support fields with structured keys.
    
    Specified by:
    
    write in interface WireOut
    
    Parameters:
    
    key - The WireKey to write to the stream.
    
    Returns:
    
    An interface to further define the output for the written value.
  - write
```
@NotNull
public @NotNull ValueOut write(@NotNull
                                        @NotNull CharSequence name)
```
    Description copied from interface: WireOut
    
    Writes a CharSequence key to the stream. This provides flexibility to write non-standard keys to the wire.
    
    Specified by:
    
    write in interface WireOut
    
    Parameters:
    
    name - The CharSequence key to write to the stream.
    
    Returns:
    
    An interface to further define the output for the written value.
  - getValueOut
```
@NotNull
public @NotNull ValueOut getValueOut()
```
    Description copied from interface: WireOut
    
    Retrieves the interface for defining the output of a value that will be written to the stream.
    
    Specified by:
    
    getValueOut in interface WireOut
    
    Returns:
    
    The interface to further define the output for the written value.
  - writeComment
```
@NotNull
public @NotNull Wire writeComment(CharSequence s)
```
    Description copied from interface: WireOut
    
    Writes a comment to the wire. Comments may be useful for debugging or providing context within the wire stream.
    
    Specified by:
    
    writeComment in interface WireOut
    
    Parameters:
    
    s - The comment to be written to the stream.
    
    Returns:
    
    This WireOut instance for method chaining.
  - addPadding
```
@NotNull
public @NotNull WireOut addPadding(int paddingToAdd)
```
    Description copied from interface: WireOut
    
    Adds padding to the wire. This is particularly useful for aligning data.
    
    Specified by:
    
    addPadding in interface WireOut
    
    Parameters:
    
    paddingToAdd - The amount of padding to add.
    
    Returns:
    
    This WireOut instance for method chaining.
  - newLongReference
```
@NotNull
public @NotNull net.openhft.chronicle.core.values.LongValue newLongReference()
```
    Description copied from interface: WireCommon
    
    Creates and returns a new LongValue. The LongValue implementation that is returned depends on the wire implementation.
    
    Specified by:
    
    newLongReference in interface WireCommon
    
    Returns:
    
    a new LongValue
  - newIntReference
```
@NotNull
public @NotNull net.openhft.chronicle.core.values.IntValue newIntReference()
```
    Description copied from interface: WireCommon
    
    Creates and returns a new IntValue. The IntValue implementation that is returned depends on the wire implementation.
    
    Specified by:
    
    newIntReference in interface WireCommon
    
    Returns:
    
    a new IntValue.
  - newLongArrayReference
```
@NotNull
public @NotNull net.openhft.chronicle.bytes.ref.BinaryLongArrayReference newLongArrayReference()
```
    Description copied from interface: WireCommon
    
    Creates and returns a new LongArrayValues. The LongArrayValues implementation that is returned depends on the wire implementation.
    
    Specified by:
    
    newLongArrayReference in interface WireCommon
    
    Returns:
    
    a new LongArrayValues
  - newIntArrayReference
```
@NotNull
public @NotNull net.openhft.chronicle.core.values.IntArrayValues newIntArrayReference()
```
    Description copied from interface: WireCommon
    
    Creates and returns a new IntArrayValues. The IntArrayValues implementation that is returned depends on the wire implementation.
    
    Specified by:
    
    newIntArrayReference in interface WireCommon
    
    Returns:
    
    a new IntArrayValues

Class RawWire

Nested Class Summary

Nested classes/interfaces inherited from interface net.openhft.chronicle.wire.WireIn

Nested classes/interfaces inherited from interface net.openhft.chronicle.wire.WireOut

Field Summary

Fields inherited from class net.openhft.chronicle.wire.AbstractWire

Fields inherited from interface net.openhft.chronicle.wire.MarshallableIn

Constructor Summary

Method Summary

Methods inherited from class net.openhft.chronicle.wire.AbstractWire

Methods inherited from class java.lang.Object

Methods inherited from interface net.openhft.chronicle.wire.Wire

Methods inherited from interface net.openhft.chronicle.wire.WireIn

Methods inherited from interface net.openhft.chronicle.wire.MarshallableIn

Methods inherited from interface net.openhft.chronicle.wire.WireOut

Methods inherited from interface net.openhft.chronicle.wire.WireCommon

Methods inherited from interface net.openhft.chronicle.wire.MarshallableOut

Methods inherited from interface net.openhft.chronicle.wire.RollbackIfNotCompleteNotifier

Constructor Detail

RawWire

RawWire

Method Detail

reset

isBinary

writingDocument

acquireWritingDocument

readingDocument

readingDocument

consumePadding

readingPeekYaml

copyTo

read

read

readEventName

readEvent

read

getValueIn

readComment

clear

newBooleanReference

useSelfDescribingMessage

bytes

readAlignTo

toString

write

writeEventName

writeEventName

writeStartEvent

writeEndEvent

write

write

getValueOut

writeComment

addPadding

newLongReference

newIntReference

newLongArrayReference

newIntArrayReference