net.openhft.chronicle.wire

Interface MarshallableIn

All Known Subinterfaces:

Wire, WireIn

All Known Implementing Classes:

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

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface MarshallableIn

Method Summary

Modifier and Type	Method and Description
default net.openhft.chronicle.bytes.MethodReader	methodReader(Object... objects) Reads messages from this tails as methods.
default VanillaMethodReaderBuilder	methodReaderBuilder()
default boolean	readBytes(net.openhft.chronicle.bytes.Bytes using)
default boolean	readBytes(net.openhft.chronicle.bytes.ReadBytesMarshallable reader)
default boolean	readDocument(ReadMarshallable reader)
DocumentContext	readingDocument()
default <K,V> Map<K,V>	readMap() Read a Map>String, Object> from the content.
default String	readText() Read the next message as a String
default boolean	readText(StringBuilder sb) Read the next message as string

Method Detail

readingDocument

@NotNull
DocumentContext readingDocument()

readDocument

default boolean readDocument(@NotNull
                             ReadMarshallable reader)

Parameters:

reader - user to read the document

Returns:

true if successful

readBytes

default boolean readBytes(@NotNull
                          net.openhft.chronicle.bytes.ReadBytesMarshallable reader)

Parameters:

reader - used to read the document

Returns:

true if successful

readBytes

default boolean readBytes(@NotNull
                          net.openhft.chronicle.bytes.Bytes using)

Parameters:

using - used to read the document

Returns:

true if successful

readText

@Nullable
default String readText()

Read the next message as a String

Returns:

the String or null if there is none.

readText

default boolean readText(@NotNull
                         StringBuilder sb)

Read the next message as string

Parameters:

sb - to copy the text into

Returns:

true if there was a message, or false if not.

readMap

@Nullable
default <K,V> Map<K,V> readMap()

Read a Map>String, Object> from the content.

Returns:

the Map, or null if no message is waiting.

methodReader

@NotNull
default net.openhft.chronicle.bytes.MethodReader methodReader(Object... objects)

Reads messages from this tails as methods. It returns a BooleanSupplier which returns

Parameters:

objects - which implement the methods serialized to the file.

Returns:

a reader which will read one Excerpt at a time

methodReaderBuilder

@NotNull
default VanillaMethodReaderBuilder methodReaderBuilder()