net.openhft.chronicle.wire

Class AbstractAnyWire

java.lang.Object

net.openhft.chronicle.wire.AbstractWire

net.openhft.chronicle.wire.AbstractAnyWire

All Implemented Interfaces:

DocumentWritten, MarshallableIn, MarshallableOut, RollbackIfNotCompleteNotifier, Wire, WireCommon, WireIn, WireOut

Direct Known Subclasses:

ReadAnyWire

public abstract class AbstractAnyWire
extends AbstractWire
implements Wire

An abstract representation of a wire type that could be either TextWire or BinaryWire. This class provides a generic foundation for wire types that could shift between the two mentioned types based on the underlying acquisition logic.

Author:

Rob Austin.

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

Modifier and Type	Field and Description
protected @NotNull net.openhft.chronicle.wire.AbstractAnyWire.WireAcquisition	wireAcquisition

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

Modifier	Constructor and Description
protected	AbstractAnyWire(@NotNull net.openhft.chronicle.bytes.Bytes<?> bytes, @NotNull net.openhft.chronicle.wire.AbstractAnyWire.WireAcquisition wa) Constructs a new instance of AbstractAnyWire using the specified bytes and wire acquisition strategy.

Method Summary

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.
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.
@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.
@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	readComment(@NotNull StringBuilder sb) Reads a comment from the Wire data and appends it to the provided StringBuilder.
<K> K	readEvent(Class<K> expectedClass) Reads a field which may contain an object of any specified type.
@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
DocumentContext	readingDocument(long readLocation) Provides a context for reading a document starting at a specific position.
String	readingPeekYaml() Peeks at the content in the current WireIn instance and returns it as a YAML string.
@NotNull Supplier<WireType>	underlyingType() Provides a supplier that indicates the type of the underlying wire.
@Nullable Wire	underlyingWire() Retrieves the underlying wire, which could be either TextWire or BinaryWire, based on the acquisition strategy.
@NotNull ValueOut	write() Writes an empty field marker to the stream.
ValueOut	write(CharSequence key) Writes a CharSequence key to the stream.
@NotNull ValueOut	write(WireKey key) Writes a WireKey to the stream.
@NotNull WireOut	writeComment(CharSequence s) Writes a comment to the wire.
void	writeEndEvent()
ValueOut	writeEvent(Class<?> expectedType, Object eventKey) Writes an event to the stream based on the type and event key.
void	writeStartEvent() Start an event object, mostly for internal use.
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

bytes, bytesComment, classLookup, classLookup, clear, 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, toString, wait, wait, wait

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

headerNumber, newYamlWireOnHeap

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

clear, commentListener, endEvent, hasMetaDataPrefix, hasMore, hintReadInputOrder, isEmpty, isEndEvent, isNotEmptyAfterPadding, objectInput, rawReadData, read, readAlignTo, readAllAsMap, readAndSetLength, readDataHeader, readDataHeader, readDocument, readDocument, readEventName, 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

clear, dropDefault, endOfWire, enterHeader, objectOutput, padToCacheAlign, updateFirstHeader, updateFirstHeader, updateHeader, writeAlignTo, writeAllAsMap, writeDocument, writeEndOfWire, writeEventId, writeEventId, writeEventName, writeEventName, writeFirstHeader, writeNotCompleteDocument, writingDocument, writingIsComplete

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

bytes, bytesComment, classLookup, classLookup, headerNumber, isBinary, newBooleanReference, newTwoLongReference, notCompleteIsNotPresent, notCompleteIsNotPresent, parent, parent, pauser, pauser, reset, usePadding, usePadding, useSelfDescribingMessage

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

Field Detail

wireAcquisition

@NotNull
protected final @NotNull net.openhft.chronicle.wire.AbstractAnyWire.WireAcquisition wireAcquisition

Constructor Detail

AbstractAnyWire

protected AbstractAnyWire(@NotNull
                          @NotNull net.openhft.chronicle.bytes.Bytes<?> bytes,
                          @NotNull
                          @NotNull net.openhft.chronicle.wire.AbstractAnyWire.WireAcquisition wa)

Constructs a new instance of AbstractAnyWire using the specified bytes and wire acquisition strategy.

Parameters:

bytes - The byte storage and manipulation object.

wa - The strategy to acquire the actual wire type.

Method Detail

underlyingWire

@Nullable
public @Nullable Wire underlyingWire()

Retrieves the underlying wire, which could be either TextWire or BinaryWire, based on the acquisition strategy.

Returns:

The underlying wire type.

underlyingType

@NotNull
public @NotNull Supplier<WireType> underlyingType()

Provides a supplier that indicates the type of the underlying wire.

Returns:

A supplier yielding the WireType.

copyTo

public void copyTo(@NotNull
                   @NotNull WireOut wire)
            throws net.openhft.chronicle.core.io.InvalidMarshallableException

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.

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException - If there's an error in the marshalling process.

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.

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.

readEvent

@Nullable
public <K> K readEvent(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.

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

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 WireIn 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.

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.

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

newLongArrayReference

@NotNull
public @NotNull net.openhft.chronicle.core.values.LongArrayValues 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

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

public 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

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.

write

@NotNull
public @NotNull ValueOut write(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

public ValueOut write(CharSequence key)

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:

key - The CharSequence key to write to the stream.

Returns:

An interface to further define the output for the written value.

writeEvent

public ValueOut writeEvent(Class<?> expectedType,
                           Object eventKey)
                    throws net.openhft.chronicle.core.io.InvalidMarshallableException

Description copied from interface: WireOut

Writes an event to the stream based on the type and event key.

Specified by:

writeEvent in interface WireOut

Parameters:

expectedType - The expected type of the event to write.

eventKey - The key of the event.

Returns:

An interface to further define the output for the written value.

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException - if there's an error marshalling the event.

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 WireOut 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.

writingDocument

public 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.

readingPeekYaml

public 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.