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, Wire, WireCommon, WireIn, WireOut

Direct Known Subclasses:

ReadAnyWire

public abstract class AbstractAnyWire
extends AbstractWire
implements Wire

A wire type than can be either

TextWire BinaryWire

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)

Method Summary

Modifier and Type	Method and Description
DocumentContext	acquireWritingDocument(boolean metaData) Start or reuse an existing a DocumentContext, optionally call close() when done.
@NotNull WireOut	addPadding(int paddingToAdd)
void	consumePadding()
void	copyTo(@NotNull WireOut wire)
@NotNull ValueIn	getValueIn() Obtain the value in for advanced use (typically after a call to readEvent above)
@NotNull ValueOut	getValueOut() Obtain the value out
@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() Read the field if present, or empty string if not present.
@NotNull ValueIn	read(@NotNull StringBuilder name) Read the field if present, or empty string if not present.
@NotNull ValueIn	read(@NotNull WireKey key) Read the field if present which must match the WireKey.
@NotNull WireIn	readComment(@NotNull StringBuilder sb)
<K> K	readEvent(Class<K> expectedClass) Read a field which might be an object of any 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)
String	readingPeekYaml()
@NotNull Supplier<WireType>	underlyingType()
@Nullable Wire	underlyingWire()
@NotNull ValueOut	write() Write an empty filed marker
ValueOut	write(CharSequence key)
@NotNull ValueOut	write(WireKey key) Write a key for wires that support fields.
@NotNull WireOut	writeComment(CharSequence s)
void	writeEndEvent()
ValueOut	writeEvent(Class expectedType, Object eventKey)
void	writeStartEvent() Start an event object, mostly for internal use.
DocumentContext	writingDocument(boolean metaData) This will increment the headerNumber as appropriate if successful

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

fromFile, headerNumber, newYamlWireOnHeap

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

asText, 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, methodWriter, methodWriterBuilder, methodWriterBuilder, recordHistory, writeBytes, writeDocument, writeDocument, writeMap, writeMessage, writeMessage, writeText

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)

Method Detail

underlyingWire

@Nullable
public @Nullable Wire underlyingWire()

underlyingType

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

copyTo

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

Specified by:

copyTo in interface WireIn

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

read

@NotNull
public @NotNull ValueIn read()

Description copied from interface: WireIn

Read the field if present, or empty string if not present.

Specified by:

read in interface WireIn

read

@NotNull
public @NotNull ValueIn read(@NotNull
                                      @NotNull WireKey key)

Description copied from interface: WireIn

Read the field if present which must match the WireKey.

Specified by:

read in interface WireIn

read

@NotNull
public @NotNull ValueIn read(@NotNull
                                      @NotNull StringBuilder name)

Description copied from interface: WireIn

Read the field if present, or empty string if not present.

Specified by:

read in interface WireIn

readEvent

@Nullable
public <K> K readEvent(Class<K> expectedClass)
                          throws net.openhft.chronicle.core.io.InvalidMarshallableException

Description copied from interface: WireIn

Read a field which might be an object of any type.

Use getValueIn() to read the value for this event

Specified by:

readEvent in interface WireIn

Parameters:

expectedClass - to use as a hint, or Object.class if no hint available.

Returns:

an instance of expectedClass

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

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

Obtain the value in for advanced use (typically after a call to readEvent above)

Specified by:

getValueIn in interface WireIn

readComment

@NotNull
public @NotNull WireIn readComment(@NotNull
                                            @NotNull StringBuilder sb)

Specified by:

readComment in interface WireIn

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)

Specified by:

readingDocument in interface WireIn

consumePadding

public void consumePadding()

Specified by:

consumePadding in interface WireIn

write

@NotNull
public @NotNull ValueOut write()

Description copied from interface: WireOut

Write an empty filed marker

Specified by:

write in interface WireOut

write

@NotNull
public @NotNull ValueOut write(WireKey key)

Description copied from interface: WireOut

Write a key for wires that support fields.

Specified by:

write in interface WireOut

write

public ValueOut write(CharSequence key)

Specified by:

write in interface WireOut

writeEvent

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

Specified by:

writeEvent in interface WireOut

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

getValueOut

@NotNull
public @NotNull ValueOut getValueOut()

Description copied from interface: WireOut

Obtain the value out

Specified by:

getValueOut in interface WireOut

writeComment

@NotNull
public @NotNull WireOut writeComment(CharSequence s)

Specified by:

writeComment in interface WireOut

addPadding

@NotNull
public @NotNull WireOut addPadding(int paddingToAdd)

Specified by:

addPadding in interface WireOut

writingDocument

public DocumentContext writingDocument(boolean metaData)

Description copied from interface: WireOut

This will increment the headerNumber as appropriate if successful

Specified by:

writingDocument in interface DocumentWritten

Specified by:

writingDocument in interface MarshallableOut

Specified by:

writingDocument in interface WireOut

Parameters:

metaData - if true the document context will be used for writing meta data, otherwise data

Returns:

a document context used for witting

acquireWritingDocument

public DocumentContext acquireWritingDocument(boolean metaData)

Description copied from interface: MarshallableOut

Start or reuse an existing a DocumentContext, optionally call close() when done.

Specified by:

acquireWritingDocument in interface DocumentWritten

Specified by:

acquireWritingDocument in interface MarshallableOut

Specified by:

acquireWritingDocument in interface WireOut

readingPeekYaml

public String readingPeekYaml()

Specified by:

readingPeekYaml in interface WireIn