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:

BaseEvent<E>, ChronicleBitSet, DynamicEnum, Event<E>, MessageHistory

All Known Implementing Classes:

AbstractClassGenerator.MetaData, AbstractEventCfg, AbstractMarshallableCfg, BytesInBinaryMarshallable, GenerateMethodDelegate.GMDMetaData, GenerateMethodWriter2.GMWMetaData, LongArrayValueBitSet, LongValueBitSet, MethodWireKey, Reductions.Counting, SelfDescribingMarshallable, SelfDescribingTriviallyCopyable, VanillaMessageHistory

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

A cornerstone interface for objects that need to be serialised to and deserialised from a wire format. It combines the ability to write and read and also extends Resettable so that implementations may be reused. Typical implementations are data transfer objects or stateful components that must be persisted or transmitted. A set of utility methods is provided for common operations such as comparison, hashing and conversion to and from textual forms.

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) Compares a given WriteMarshallable object with another object for equality.
default @NotNull Map<String,FieldInfo>	$fieldInfoMap() Retrieves a map of field information for the current class, with field names as keys.
default @NotNull List<FieldInfo>	$fieldInfos() Retrieves the list of field information for the current class.
static int	$hashCode(WriteMarshallable $this) Generates a 32-bit hash code for a given WriteMarshallable object.
static String	$toString(WriteMarshallable $this) Converts a given WriteMarshallable object into its string representation.
default String	className() Returns the alias name for the current class, if available.
default <T extends Marshallable> T	copyTo(T dest) Copy fields from this to dest by marshalling out and then in.
default <T> T	deepCopy() Creates a deep copy of the current marshallable object.
static <T> T	fromFile(@NotNull Class<T> expectedType, String filename) Reads a file, either from the current working directory or the classpath, and interprets its content as a marshallable object of a specific type.
static <T> T	fromFile(String filename) Reads a file, either from the current working directory or the classpath, and interprets its content as a marshallable object.
static <T> T	fromString(@NotNull CharSequence cs) Converts a CharSequence into its corresponding marshallable representation.
static <T> T	fromString(@NotNull Class<T> tClass, @NotNull CharSequence cs) Converts a CharSequence into its corresponding marshallable representation, expecting a specific type as the result.
static <T> T	fromString(@NotNull InputStream is) Converts the content from an InputStream into its corresponding marshallable representation.
default <T> T	getField(String name, Class<T> tClass) Retrieves the value of a specific field from the current marshallable object, expecting a certain type for the field's value.
default long	getLongField(String name) Retrieves the long value of a specific field from the current marshallable object.
default <K,T extends Marshallable> T	mergeToMap(@NotNull Map<K,T> map, @NotNull Function<T,K> getKey) Merges the current marshallable object into a map, using a specified function to determine the key.
default void	readMarshallable(@NotNull WireIn wire) Reads the state of the Marshallable object from the given wire input.
default void	reset() Resets the current marshallable object to its initial state.
default void	setField(String name, Object value) Sets the value of a specific field in the current marshallable object.
default void	setLongField(String name, long value) Sets the long value of a specific field in the current marshallable object.
static <T> @Nullable Stream<T>	streamFromFile(@NotNull Class<T> expectedType, String filename) Streams the content of a file as marshallable objects of a specific type.
static <T> @NotNull Stream<T>	streamFromFile(String filename) Streams the content of a file as marshallable objects.
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)

Compares a given WriteMarshallable object with another object for equality.

Parameters:

$this - The reference WriteMarshallable object.

o - The object to compare with.

Returns:

true if both objects are equal, false otherwise.

$hashCode

static int $hashCode(WriteMarshallable $this)

Generates a 32-bit hash code for a given WriteMarshallable object.

Parameters:

$this - The reference WriteMarshallable object.

Returns:

The 32-bit hash code.

$toString

static String $toString(WriteMarshallable $this)

Converts a given WriteMarshallable object into its string representation.

Parameters:

$this - The reference WriteMarshallable object.

Returns:

A string representation of the object.

fromString

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

Converts a CharSequence into its corresponding marshallable representation.

Parameters:

cs - The character sequence to convert.

Returns:

The corresponding marshallable object, or null if the conversion is not possible.

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

Converts a CharSequence into its corresponding marshallable representation, expecting a specific type as the result.

Parameters:

tClass - The expected class of the resulting object.

cs - The character sequence to convert.

Returns:

The corresponding marshallable object of type T, or null if the conversion is not possible.

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

fromFile

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

Reads a file, either from the current working directory or the classpath, and interprets its content as a marshallable object. The method supports various file formats and relies on the underlying marshallable parsing logic to interpret the content.

Parameters:

filename - The name or path of the file to read.

Returns:

The marshallable object interpreted from the file content.

Throws:

IOException

net.openhft.chronicle.core.io.InvalidMarshallableException

fromString

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

Converts the content from an InputStream into its corresponding marshallable representation.

Parameters:

is - The input stream containing the content to convert.

Returns:

The corresponding marshallable object, or null if the conversion is not possible.

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 a file, either from the current working directory or the classpath, and interprets its content as a marshallable object of a specific type.

Parameters:

expectedType - The expected type of the resulting object.

filename - The name or path of the file to read.

Returns:

The marshallable object interpreted from the file content.

Throws:

IOException

net.openhft.chronicle.core.io.InvalidMarshallableException

streamFromFile

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

Streams the content of a file as marshallable objects.

Parameters:

filename - The name or path of the file to read.

Returns:

A stream of marshallable objects.

Throws:

IOException

streamFromFile

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

Streams the content of a file as marshallable objects of a specific type.

Parameters:

expectedType - The expected type of the resulting objects in the stream.

filename - The name or path of the file to read.

Returns:

A stream of marshallable objects of type T.

Throws:

IOException

getField

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

Retrieves the value of a specific field from the current marshallable object, expecting a certain type for the field's value.

Parameters:

name - The name of the field.

tClass - The expected class/type of the field's value.

Returns:

The value of the specified field.

Throws:

NoSuchFieldException

setField

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

Sets the value of a specific field in the current marshallable object.

Parameters:

name - The name of the field.

value - The new value for the specified field.

Throws:

NoSuchFieldException

getLongField

default long getLongField(String name)
                   throws NoSuchFieldException

Retrieves the long value of a specific field from the current marshallable object.

Parameters:

name - The name of the field.

Returns:

The long value of the specified field.

Throws:

NoSuchFieldException

setLongField

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

Sets the long value of a specific field in the current marshallable object.

Parameters:

name - The name of the field.

value - The new long value for the specified field.

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

Creates a deep copy of the current marshallable object.

Returns:

The deep copy of the current object.

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

copyTo

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

Copy fields from this to dest by marshalling out and then in. Allows copying of fields by name even if there is no type relationship between this and dest

Type Parameters:

T - destination type

Parameters:

dest - destination

Returns:

t

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)

Merges the current marshallable object into a map, using a specified function to determine the key.

Parameters:

map - The map to merge into.

getKey - The function to determine the key for the current object in the map.

Returns:

The merged marshallable object in the map.

$fieldInfos

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

Retrieves the list of field information for the current class.

Returns:

A list of field information objects.

$fieldInfoMap

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

Retrieves a map of field information for the current class, with field names as keys.

Returns:

A map with field names as keys and field information objects as values.

className

default String className()

Returns the alias name for the current class, if available.

Returns:

The alias name for the current class or the canonical name if no alias exists.

reset

default void reset()

Resets the current marshallable object to its initial state.

Specified by:

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