net.openhft.chronicle.wire

Interface Marshallable

All Superinterfaces:

net.openhft.chronicle.bytes.CommonMarshallable, ReadMarshallable, net.openhft.chronicle.core.io.Resettable, WriteMarshallable, WriteValue

All Known Subinterfaces:

ChannelHandler, ChannelHeader, ChronicleBitSet, DynamicEnum, Event<E>, MessageHistory

All Known Implementing Classes:

AbstractClassGenerator.MetaData, AbstractCommonMarshallable, AbstractEventCfg, AbstractHandler, AbstractHeader, AbstractMarshallableCfg, BytesInBinaryMarshallable, ChronicleChannelCfg, ChronicleChannelSupplier, ChronicleServiceMain, EchoHandler, ErrorHeader, ErrorReplyHandler, GatewayHandler, GenerateMethodDelegate.GMDMetaData, GenerateMethodWriter2.GMWMetaData, HostPortCfg, LongArrayValueBitSet, LongValueBitSet, MethodWireKey, OkHeader, RedirectHeader, Reductions.Counting, ReplyHeader, ReplyingHandler, SelfDescribingMarshallable, SelfDescribingTriviallyCopyable, SystemContext, VanillaMessageHistory

public interface Marshallable
extends WriteMarshallable, ReadMarshallable, net.openhft.chronicle.core.io.Resettable

The implementation of this interface is both readable and write-able as marshallable data.

Field Summary

Fields inherited from interface net.openhft.chronicle.wire.WriteMarshallable

EMPTY

Fields inherited from interface net.openhft.chronicle.wire.ReadMarshallable

DISCARD

Method Summary

Modifier and Type	Method and Description
static boolean	$equals(@NotNull WriteMarshallable $this, Object o)
default @NotNull Map<String,FieldInfo>	$fieldInfoMap()
default @NotNull List<FieldInfo>	$fieldInfos()
static int	$hashCode(WriteMarshallable $this)
static String	$toString(WriteMarshallable $this)
default String	className()
default <T extends Marshallable> T	copyTo(T t)
default <T> T	deepCopy()
static <T> T	fromFile(@NotNull Class<T> expectedType, String filename) Reads the file from the current working directory, or the class path.
static <T> T	fromFile(String filename) Reads the file from the current working directory, or the class path.
static <T> T	fromString(@NotNull CharSequence cs)
static <T> T	fromString(@NotNull Class<T> tClass, @NotNull CharSequence cs)
static <T> T	fromString(@NotNull InputStream is)
default <T> T	getField(String name, Class<T> tClass)
default long	getLongField(String name)
default <K,T extends Marshallable> T	mergeToMap(@NotNull Map<K,T> map, @NotNull Function<T,K> getKey)
default void	readMarshallable(@NotNull WireIn wire) Reads the state of the Marshallable object from the given wire input.
default void	reset()
default void	setField(String name, Object value)
default void	setLongField(String name, long value)
static <T> @Nullable Stream<T>	streamFromFile(@NotNull Class<T> expectedType, String filename)
static <T> @NotNull Stream<T>	streamFromFile(String filename)
default void	writeMarshallable(@NotNull WireOut wire) Writes the state of the Marshallable object to the given wire output.

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

binaryLengthLength, writeValue

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

unexpectedField

Methods inherited from interface net.openhft.chronicle.bytes.CommonMarshallable

usesSelfDescribingMessage

Method Detail

$equals

static boolean $equals(@NotNull
                       @NotNull WriteMarshallable $this,
                       Object o)

$hashCode

static int $hashCode(WriteMarshallable $this)

$toString

static String $toString(WriteMarshallable $this)

fromString

@Nullable
static <T> T fromString(@NotNull
                                  @NotNull CharSequence cs)
                           throws net.openhft.chronicle.core.io.InvalidMarshallableException

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

fromString

@Nullable
static <T> T fromString(@NotNull
                                  @NotNull Class<T> tClass,
                                  @NotNull
                                  @NotNull CharSequence cs)
                           throws net.openhft.chronicle.core.io.InvalidMarshallableException

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

fromFile

@NotNull
static <T> T fromFile(String filename)
                        throws IOException,
                               net.openhft.chronicle.core.io.InvalidMarshallableException

Reads the file from the current working directory, or the class path.

Parameters:

filename - or path to read

Returns:

the marshallable object

Throws:

IOException

net.openhft.chronicle.core.io.InvalidMarshallableException

fromString

static <T> T fromString(@NotNull
                        @NotNull InputStream is)
                 throws net.openhft.chronicle.core.io.InvalidMarshallableException

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

fromFile

@Nullable
static <T> T fromFile(@NotNull
                                @NotNull Class<T> expectedType,
                                String filename)
                         throws IOException,
                                net.openhft.chronicle.core.io.InvalidMarshallableException

Reads the file from the current working directory, or the class path.

Parameters:

filename - or path to read

expectedType - to deserialize as

Returns:

the marshallable object

Throws:

IOException

net.openhft.chronicle.core.io.InvalidMarshallableException

streamFromFile

@NotNull
static <T> @NotNull Stream<T> streamFromFile(String filename)
                                               throws IOException

Throws:

IOException

streamFromFile

@Nullable
static <T> @Nullable Stream<T> streamFromFile(@NotNull
                                                        @NotNull Class<T> expectedType,
                                                        String filename)
                                                 throws IOException

Throws:

IOException

getField

@Nullable
default <T> T getField(String name,
                                 Class<T> tClass)
                          throws NoSuchFieldException

Throws:

NoSuchFieldException

setField

default void setField(String name,
                      Object value)
               throws NoSuchFieldException

Throws:

NoSuchFieldException

getLongField

default long getLongField(String name)
                   throws NoSuchFieldException

Throws:

NoSuchFieldException

setLongField

default void setLongField(String name,
                          long value)
                   throws NoSuchFieldException

Throws:

NoSuchFieldException

readMarshallable

default void readMarshallable(@NotNull
                              @NotNull WireIn wire)
                       throws net.openhft.chronicle.core.io.IORuntimeException,
                              net.openhft.chronicle.core.io.InvalidMarshallableException

Reads the state of the Marshallable object from the given wire input. The method obtains a WireMarshaller specific to the class of the current object and delegates the reading process to that marshaller.

The default implementation will use a default value for each field not present

Specified by:

readMarshallable in interface ReadMarshallable

Parameters:

wire - The wire input source.

Throws:

net.openhft.chronicle.core.io.IORuntimeException - If an IO error occurs during the read operation.

net.openhft.chronicle.core.io.InvalidMarshallableException - If there's an error during marshalling.

writeMarshallable

default void writeMarshallable(@NotNull
                               @NotNull WireOut wire)
                        throws net.openhft.chronicle.core.io.InvalidMarshallableException

Writes the state of the Marshallable object to the given wire output. The method obtains a WireMarshaller specific to the class of the current object and delegates the writing process to that marshaller.

The default implementation will write all values even if they are a default value. c.f. readMarshallable

Specified by:

writeMarshallable in interface WriteMarshallable

Parameters:

wire - The wire output destination.

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException - If there's an error during marshalling.

deepCopy

@NotNull
default <T> T deepCopy()
                         throws net.openhft.chronicle.core.io.InvalidMarshallableException

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

copyTo

default <T extends Marshallable> T copyTo(@NotNull
                                          T t)
                                   throws net.openhft.chronicle.core.io.InvalidMarshallableException

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

mergeToMap

default <K,T extends Marshallable> T mergeToMap(@NotNull
                                                @NotNull Map<K,T> map,
                                                @NotNull
                                                @NotNull Function<T,K> getKey)

$fieldInfos

@NotNull
default @NotNull List<FieldInfo> $fieldInfos()

$fieldInfoMap

@NotNull
default @NotNull Map<String,FieldInfo> $fieldInfoMap()

className

default String className()

reset

default void reset()

Specified by:

reset in interface net.openhft.chronicle.core.io.Resettable