net.openhft.chronicle.wire

Interface WireIn

All Superinterfaces:

MarshallableIn, WireCommon

All Known Subinterfaces:

Wire

All Known Implementing Classes:

AbstractAnyWire, AbstractWire, BinaryWire, CSVWire, DeferredTypeWire, JSONWire, QueryWire, RawWire, ReadAnyWire, ResultSetWireIn, TextWire

public interface WireIn
extends WireCommon, MarshallableIn

The defines the stand interface for writing and reading sequentially to/from a Bytes stream.

Created by peter.lawrey on 12/01/15.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	WireIn.HeaderType

Method Summary

Modifier and Type	Method and Description
default CharSequence	asText()
void	clear() reset the state of the current wire for reuse.
void	consumePadding()
void	copyTo(WireOut wire)
ValueIn	getValueIn() Obtain the value in (for internal use)
default boolean	hasMore() This consumes any padding before checking if readRemaining() > 0
default boolean	isEmpty()
default boolean	isNotEmptyAfterPadding() This consumes any padding before checking if readRemaining() > 0
ObjectInput	objectInput()
default void	rawReadData(ReadMarshallable marshallable)
ValueIn	read() Read the field if present, or empty string if not present.
default ValueIn	read(String fieldName)
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.
default WireIn	readAlignTo(int alignment)
default <K,V> Map<K,V>	readAllAsMap(Class<K> kClass, Class<V> vClass, Map<K,V> map)
void	readAndSetLength(long position)
WireIn	readComment(StringBuilder sb)
default boolean	readDataHeader() Consume a header if one is available.
WireIn.HeaderType	readDataHeader(boolean includeMetaData)
default boolean	readDocument(long position, ReadMarshallable metaDataConsumer, ReadMarshallable dataConsumer)
default boolean	readDocument(ReadMarshallable metaDataConsumer, ReadMarshallable dataConsumer)
<K> K	readEvent(Class<K> expectedClass) Read a field which might be an object of any type.
default ValueIn	readEventName(StringBuilder name) Read a field, or string which is always written, even for formats which might drop the field such as RAW.
void	readFirstHeader(long timeout, TimeUnit timeUnit)
DocumentContext	readingDocument() equivalent to 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	readMetaDataHeader()

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

bytes, classLookup, classLookup, endUse, headerNumber, headerNumber, newIntReference, newLongArrayReference, newLongReference, notCompleteIsNotPresent, notCompleteIsNotPresent, parent, parent, pauser, pauser, startUse

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

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

Method Detail

readAllAsMap

@NotNull
default <K,V> Map<K,V> readAllAsMap(Class<K> kClass,
                                             @NotNull
                                             Class<V> vClass,
                                             @NotNull
                                             Map<K,V> map)

copyTo

void copyTo(@NotNull
            WireOut wire)

read

@NotNull
ValueIn read()

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

read

@NotNull
ValueIn read(@NotNull
                      WireKey key)

Read the field if present which must match the WireKey.

read

@NotNull
default ValueIn read(String fieldName)

readEventName

@NotNull
default ValueIn readEventName(@NotNull
                                       StringBuilder name)

Read a field, or string which is always written, even for formats which might drop the field such as RAW.

read

@NotNull
ValueIn read(@NotNull
                      StringBuilder name)

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

readEvent

@Nullable
<K> K readEvent(Class<K> expectedClass)

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

Parameters:

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

Returns:

an instance of expectedClass

getValueIn

@NotNull
ValueIn getValueIn()

Obtain the value in (for internal use)

objectInput

ObjectInput objectInput()

readComment

@NotNull
WireIn readComment(@NotNull
                            StringBuilder sb)

clear

void clear()

Description copied from interface: WireCommon

reset the state of the current wire for reuse.

Specified by:

clear in interface WireCommon

hasMore

default boolean hasMore()

This consumes any padding before checking if readRemaining() > 0

NOTE: This method only works inside a document. Call it just before a document and it won't know not to read the read in case there is padding.

Returns:

if there is more data to be read in this document.

isNotEmptyAfterPadding

default boolean isNotEmptyAfterPadding()

This consumes any padding before checking if readRemaining() > 0

NOTE: This method only works inside a document. Call it just before a document and it won't know not to read the read in case there is padding.

Returns:

if there is more data to be read in this document.

isEmpty

default boolean isEmpty()

readAlignTo

@NotNull
default WireIn readAlignTo(int alignment)

readDocument

default boolean readDocument(@Nullable
                             ReadMarshallable metaDataConsumer,
                             @Nullable
                             ReadMarshallable dataConsumer)

readDocument

default boolean readDocument(long position,
                             @Nullable
                             ReadMarshallable metaDataConsumer,
                             @Nullable
                             ReadMarshallable dataConsumer)

rawReadData

default void rawReadData(@NotNull
                         ReadMarshallable marshallable)

readingDocument

@NotNull
DocumentContext readingDocument()

equivalent to 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

Returns:

the document context

readingDocument

DocumentContext readingDocument(long readLocation)

consumePadding

void consumePadding()

readDataHeader

default boolean readDataHeader()
                        throws EOFException

Consume a header if one is available.

Returns:

true, if a message can be read between readPosition and readLimit, else false if no header is ready.

Throws:

EOFException - if the end of wire marker is reached.

readDataHeader

@NotNull
WireIn.HeaderType readDataHeader(boolean includeMetaData)
                                   throws EOFException

Throws:

EOFException

readAndSetLength

void readAndSetLength(long position)

readFirstHeader

void readFirstHeader(long timeout,
                     TimeUnit timeUnit)
              throws TimeoutException,
                     StreamCorruptedException

Throws:

TimeoutException

StreamCorruptedException

readMetaDataHeader

void readMetaDataHeader()

asText

@Nullable
default CharSequence asText()

readingPeekYaml

String readingPeekYaml()