net.openhft.chronicle.wire

Interface MarshallableIn

All Known Subinterfaces:

ChronicleChannel, InternalChronicleChannel, Wire, WireIn

All Known Implementing Classes:

AbstractAnyWire, AbstractWire, BinaryWire, BufferedChronicleChannel, CSVWire, DelegateChronicleChannel, EchoChannel, JSONWire, QueryWire, RawWire, ReadAnyWire, TCPChronicleChannel, TextWire, YamlWire, YamlWireOut

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

Anything you can read marshallable object from.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MARSHALLABLE_IN_INTERN_SIZE

Method Summary

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

Field Detail

MARSHALLABLE_IN_INTERN_SIZE

static final int MARSHALLABLE_IN_INTERN_SIZE

Method Detail

readingDocument

@NotNull
@NotNull DocumentContext readingDocument()

readDocument

default boolean readDocument(@NotNull
                             @NotNull ReadMarshallable reader)
                      throws net.openhft.chronicle.core.io.InvalidMarshallableException

Parameters:

reader - user to read the document

Returns:

true if successful

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

readBytes

default boolean readBytes(@NotNull
                          @NotNull net.openhft.chronicle.bytes.ReadBytesMarshallable reader)
                   throws net.openhft.chronicle.core.io.InvalidMarshallableException

Parameters:

reader - used to read the document

Returns:

true if successful

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

readBytes

default boolean readBytes(@NotNull
                          @NotNull net.openhft.chronicle.bytes.Bytes<?> using)
                   throws net.openhft.chronicle.core.io.InvalidMarshallableException

Parameters:

using - used to read the document

Returns:

true if successful

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

readText

@Nullable
default @Nullable String readText()
                                     throws net.openhft.chronicle.core.io.InvalidMarshallableException

Read the next message as a String

Returns:

the String or null if there is none.

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

readText

default boolean readText(@NotNull
                         @NotNull StringBuilder sb)
                  throws net.openhft.chronicle.core.io.InvalidMarshallableException

Read the next message as string

Parameters:

sb - to copy the text into

Returns:

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

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

readMap

@Nullable
default <K,V> @Nullable Map<K,V> readMap()
                                            throws net.openhft.chronicle.core.io.InvalidMarshallableException

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

Returns:

the Map, or null if no message is waiting.

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

methodReader

@NotNull
default @NotNull 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 @NotNull VanillaMethodReaderBuilder methodReaderBuilder()