net.openhft.chronicle.wire

Interface WireIn

All Superinterfaces:

WireCommon

All Known Subinterfaces:

InternalWire, Wire

All Known Implementing Classes:

BinaryWire, CSVWire, JSONWire, QueryWire, RawWire, TextWire

public interface WireIn
extends WireCommon

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

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

Method Summary

Modifier and Type	Method and Description
void	clear()
void	copyTo(WireOut wire)
ValueIn	getValueIn() Obtain the value in (for internal use)
boolean	hasMore()
boolean	isReady()
default void	rawReadData(ReadMarshallable marshallable)
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.
default WireIn	readAlignTo(int alignment)
Wire	readComment(StringBuilder sb)
default boolean	readDocument(long position, ReadMarshallable metaDataConsumer, ReadMarshallable dataConsumer)
default boolean	readDocument(ReadMarshallable metaDataConsumer, ReadMarshallable dataConsumer)
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.
DocumentContext	readingDocument()
DocumentContext	readingDocument(long readLocation)

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

bytes, newIntReference, newLongArrayReference, newLongReference

Method Detail

isReady

boolean isReady()

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.

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.

getValueIn

@NotNull
ValueIn getValueIn()

Obtain the value in (for internal use)

readComment

@NotNull
Wire readComment(@NotNull
                          StringBuilder sb)

clear

void clear()

hasMore

boolean hasMore()

Returns:

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

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(ReadMarshallable marshallable)

readingDocument

DocumentContext readingDocument()

readingDocument

DocumentContext readingDocument(long readLocation)