net.openhft.chronicle.wire

Class AbstractAnyWire

java.lang.Object

net.openhft.chronicle.wire.AbstractWire

net.openhft.chronicle.wire.AbstractAnyWire

All Implemented Interfaces:

MarshallableIn, MarshallableOut, Wire, WireCommon, WireIn, WireOut

Direct Known Subclasses:

DeferredTypeWire, 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.MarshallableOut

MarshallableOut.Padding

Field Summary

Fields

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

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

ASSERTIONS, bytes, classLookup, parent, use8bit

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

MARSHALLABLE_IN_INTERN_SIZE

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

DEFAULT_SAFE_LENGTH, TRY_WRITE_HEADER_FAILED

Constructor Summary

Constructors

Constructor and Description
AbstractAnyWire(net.openhft.chronicle.bytes.Bytes bytes, net.openhft.chronicle.wire.AbstractAnyWire.WireAcquisition wa)

Method Summary

Modifier and Type	Method and Description
WireOut	addPadding(int paddingToAdd)
void	consumePadding()
void	copyTo(WireOut wire)
void	endEvent()
ValueIn	getValueIn() Obtain the value in (for internal use)
ValueOut	getValueOut() Obtain the value out
boolean	isTextWire()
net.openhft.chronicle.core.values.IntValue	newIntReference()
net.openhft.chronicle.core.values.LongArrayValues	newLongArrayReference()
net.openhft.chronicle.core.values.LongValue	newLongReference()
ValueIn	read() Read the field if present, or empty string if not present.
ValueIn	read(StringBuilder name) Read the field if present, or empty string if not present.
ValueIn	read(WireKey key) Read the field if present which must match the WireKey.
WireIn	readComment(StringBuilder sb)
<K> K	readEvent(Class<K> expectedClass) Read a field which might be an object of any type.
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()
void	startEvent() Start an event object, mostly for internal use.
Supplier<WireType>	underlyingType()
Wire	underlyingWire()
ValueOut	write() Write an empty filed marker
ValueOut	write(CharSequence key)
ValueOut	write(WireKey key) Write a key for wires that support fields.
WireOut	writeComment(CharSequence s)
ValueOut	writeEvent(Class expectedType, Object eventKey)
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, endUse, enterHeader, forceNotInsideHeader, headerNumber, headerNumber, headNumberCheck, isInsideHeader, notCompleteIsNotPresent, notCompleteIsNotPresent, objectInput, objectOutput, parent, parent, pauser, pauser, readAndSetLength, readDataHeader, readEventNumber, readFirstHeader, readFirstHeader, readMetaDataHeader, startUse, updateFirstHeader, updateHeader, writeEndOfWire, writeFirstHeader, writeHeaderOfUnknownLength

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

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

asText, clear, hasMore, isEmpty, isNotEmptyAfterPadding, objectInput, rawReadData, read, readAlignTo, readAllAsMap, readAndSetLength, readDataHeader, readDataHeader, readDocument, readDocument, readEventName, readEventNumber, readFirstHeader, readFirstHeader, readMetaDataHeader

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

methodReader, methodReaderBuilder, peekDocument, readBytes, readBytes, readDocument, readMap, readText, readText

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

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

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

bytes, bytesComment, classLookup, classLookup, endUse, headerNumber, newBooleanReference, newTwoLongReference, notCompleteIsNotPresent, notCompleteIsNotPresent, parent, parent, pauser, pauser, startUse

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

methodWriter, methodWriter, methodWriterBuilder, padToCacheAlignMode, recordHistory, writeBytes, writeDocument, writeDocument, writeMap, writeMessage, writeText

Field Detail

wireAcquisition

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

Constructor Detail

AbstractAnyWire

public AbstractAnyWire(@NotNull
                       net.openhft.chronicle.bytes.Bytes bytes,
                       @NotNull
                       net.openhft.chronicle.wire.AbstractAnyWire.WireAcquisition wa)

Method Detail

underlyingWire

@Nullable
public Wire underlyingWire()

underlyingType

@NotNull
public Supplier<WireType> underlyingType()

copyTo

public void copyTo(@NotNull
                   WireOut wire)

Specified by:

copyTo in interface WireIn

read

@NotNull
public 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 ValueIn read(@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 ValueIn read(@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)

Description copied from interface: WireIn

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

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

startEvent

public void startEvent()

Description copied from interface: WireOut

Start an event object, mostly for internal use.

Specified by:

startEvent in interface WireOut

endEvent

public void endEvent()

Specified by:

endEvent in interface WireOut

getValueIn

@NotNull
public ValueIn getValueIn()

Description copied from interface: WireIn

Obtain the value in (for internal use)

Specified by:

getValueIn in interface WireIn

readComment

@NotNull
public WireIn readComment(@NotNull
                                   StringBuilder sb)

Specified by:

readComment in interface WireIn

newIntReference

@NotNull
public net.openhft.chronicle.core.values.IntValue newIntReference()

Specified by:

newIntReference in interface WireCommon

Returns:

an IntValue which appropriate for this wire.

newLongReference

@NotNull
public net.openhft.chronicle.core.values.LongValue newLongReference()

Specified by:

newLongReference in interface WireCommon

Returns:

a LongValue which appropriate for this wire.

newLongArrayReference

@NotNull
public net.openhft.chronicle.core.values.LongArrayValues newLongArrayReference()

Specified by:

newLongArrayReference in interface WireCommon

Returns:

a LongArrayValue which appropriate for this wire.

readingDocument

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

Description copied from interface: WireOut

Write an empty filed marker

Specified by:

write in interface WireOut

write

@NotNull
public 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)

Specified by:

writeEvent in interface WireOut

getValueOut

@NotNull
public ValueOut getValueOut()

Description copied from interface: WireOut

Obtain the value out

Specified by:

getValueOut in interface WireOut

writeComment

@NotNull
public WireOut writeComment(CharSequence s)

Specified by:

writeComment in interface WireOut

addPadding

@NotNull
public 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 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

readingPeekYaml

public String readingPeekYaml()

Specified by:

readingPeekYaml in interface WireIn

isTextWire

public boolean isTextWire()

Specified by:

isTextWire in interface WireCommon