net.openhft.chronicle.wire

Interface Marshallable

All Superinterfaces:

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

All Known Subinterfaces:

MessageHistory

All Known Implementing Classes:

AbstractBytesMarshallable, AbstractMarshallable, AbstractMarshallableCfg, LongValueBitSet, MethodWireKey, 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(WriteMarshallable $this, Object o)
default List<FieldInfo>	$fieldInfos()
static int	$hashCode(WriteMarshallable $this)
static String	$toString(WriteMarshallable $this)
default <T extends Marshallable> T	copyFrom(T t) Deprecated.
default <T extends Marshallable> T	copyTo(T t)
default <T> T	deepCopy()
static <T> T	fromFile(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 Map<String,Object>	fromFileAsMap(String filename) Deprecated.
static <V> Map<String,V>	fromFileAsMap(String filename, Class<V> valueClass) Deprecated.
static Map<String,Object>	fromHexString(CharSequence cs) Deprecated.
static <T> T	fromString(CharSequence cs)
static <T> T	fromString(Class<T> tClass, CharSequence cs)
static <T> T	fromString(InputStream is)
default String	getClassName()
default <T> T	getField(String name, Class<T> tClass)
default <K,T extends Marshallable> T	mergeToMap(Map<K,T> map, Function<T,K> getKey)
default void	readMarshallable(WireIn wire) Straight line ordered decoding.
default void	reset()
default void	setField(String name, Object value)
static <T> Stream<T>	streamFromFile(Class<T> expectedType, String filename)
static <T> Stream<T>	streamFromFile(String filename)
default void	writeMarshallable(WireOut wire) Write data to the wire

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

writeValue

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

unexpectedField

Method Detail

$equals

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

$hashCode

static int $hashCode(WriteMarshallable $this)

$toString

static String $toString(WriteMarshallable $this)

fromString

@Nullable
static <T> T fromString(@NotNull
                                  CharSequence cs)

fromString

@Nullable
static <T> T fromString(@NotNull
                                  Class<T> tClass,
                                  @NotNull
                                  CharSequence cs)

fromFile

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

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

Parameters:

filename - or path to read

Returns:

the marshallable object

Throws:

IOException

fromString

static <T> T fromString(@NotNull
                        InputStream is)

fromFile

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

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

streamFromFile

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

Throws:

IOException

streamFromFile

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

Throws:

IOException

fromFileAsMap

@Deprecated
 @NotNull
static Map<String,Object> fromFileAsMap(String filename)
                                                       throws IOException

Deprecated.

Throws:

IOException

fromFileAsMap

@Deprecated
 @NotNull
static <V> Map<String,V> fromFileAsMap(String filename,
                                                             @NotNull
                                                             Class<V> valueClass)
                                                      throws IOException

Deprecated.

Throws:

IOException

fromHexString

@Deprecated
 @Nullable
static Map<String,Object> fromHexString(@NotNull
                                                               CharSequence cs)

Deprecated.

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

readMarshallable

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

Description copied from interface: ReadMarshallable

Straight line ordered decoding.

Specified by:

readMarshallable in interface ReadMarshallable

Parameters:

wire - to read from in an ordered manner.

Throws:

net.openhft.chronicle.core.io.IORuntimeException - the stream wasn't ordered or formatted as expected.

writeMarshallable

default void writeMarshallable(@NotNull
                               WireOut wire)

Description copied from interface: WriteMarshallable

Write data to the wire

Specified by:

writeMarshallable in interface WriteMarshallable

Parameters:

wire - to write to.

deepCopy

@NotNull
default <T> T deepCopy()

copyFrom

@Deprecated
 @NotNull
default <T extends Marshallable> T copyFrom(@NotNull
                                                                  T t)

Deprecated.

copyTo

default <T extends Marshallable> T copyTo(@NotNull
                                          T t)

mergeToMap

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

$fieldInfos

@NotNull
default List<FieldInfo> $fieldInfos()

getClassName

default String getClassName()

reset

default void reset()

Specified by:

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