net.openhft.chronicle.wire

Class ReadAnyWire

java.lang.Object

net.openhft.chronicle.wire.AbstractWire

net.openhft.chronicle.wire.AbstractAnyWire

net.openhft.chronicle.wire.ReadAnyWire

All Implemented Interfaces:

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

public class ReadAnyWire
extends AbstractAnyWire
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 inherited from class net.openhft.chronicle.wire.AbstractAnyWire

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

Constructor and Description
ReadAnyWire(@NotNull net.openhft.chronicle.bytes.Bytes<?> bytes)

Method Summary

Modifier and Type	Method and Description
@NotNull net.openhft.chronicle.bytes.Bytes<?>	bytes() Returns the underlying Bytes stored by the wire.
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.
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.
void	reset() Reset the state of the wire
boolean	useSelfDescribingMessage(@NotNull net.openhft.chronicle.bytes.CommonMarshallable object) Should this wire write the object as a Marshallable or BytesMarshallable

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

acquireWritingDocument, addPadding, consumePadding, copyTo, getValueIn, getValueOut, newIntArrayReference, newIntReference, newLongArrayReference, newLongReference, read, read, read, readComment, readEvent, readingDocument, readingDocument, readingPeekYaml, underlyingType, underlyingWire, write, write, write, writeComment, writeEndEvent, writeEvent, writeStartEvent, writingDocument

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

bytesComment, 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, commentListener, consumePadding, copyTo, endEvent, getValueIn, hasMetaDataPrefix, hasMore, hintReadInputOrder, isEmpty, isEndEvent, isNotEmptyAfterPadding, objectInput, rawReadData, read, read, read, read, readAlignTo, readAllAsMap, readAndSetLength, readComment, readDataHeader, readDataHeader, readDocument, readDocument, readEvent, readEventName, readEventNumber, readFirstHeader, readFirstHeader, readingDocument, readingDocument, readingPeekYaml, 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

acquireWritingDocument, addPadding, dropDefault, endOfWire, enterHeader, getValueOut, objectOutput, padToCacheAlign, updateFirstHeader, updateFirstHeader, updateHeader, write, write, write, writeAlignTo, writeAllAsMap, writeComment, writeDocument, writeEndEvent, writeEndOfWire, writeEvent, writeEventId, writeEventId, writeEventName, writeEventName, writeFirstHeader, writeNotCompleteDocument, writeStartEvent, writingDocument, writingDocument, writingIsComplete

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

bytesComment, headerNumber, newIntArrayReference, newIntReference, newLongArrayReference, newLongReference, newTwoLongReference, notCompleteIsNotPresent, notCompleteIsNotPresent, parent, parent, pauser, pauser, usePadding, usePadding

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

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

Constructor Detail

ReadAnyWire

public ReadAnyWire(@NotNull
                   @NotNull net.openhft.chronicle.bytes.Bytes<?> bytes)

Method Detail

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

classLookup

public void classLookup(net.openhft.chronicle.core.pool.ClassLookup classLookup)

Description copied from interface: WireCommon

Sets the ClassLookup implementation to be used for class lookup.

Specified by:

classLookup in interface WireCommon

Overrides:

classLookup in class AbstractWire

Parameters:

classLookup - implementation to be used for class lookup.

classLookup

public net.openhft.chronicle.core.pool.ClassLookup classLookup()

Description copied from interface: WireCommon

Returns the current ClassLookup implementation being used for class lookup.

Specified by:

classLookup in interface WireCommon

Overrides:

classLookup in class AbstractWire

Returns:

the current ClassLookup implementation being used for class lookup

clear

public void clear()

Description copied from interface: WireCommon

Resets the state of the underlying Bytes stored by the wire.

Specified by:

clear in interface WireCommon

Specified by:

clear in interface WireIn

Specified by:

clear in interface WireOut

Overrides:

clear in class AbstractWire

reset

public void reset()

Description copied from interface: WireCommon

Reset the state of the wire

Specified by:

reset in interface WireCommon

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