net.openhft.chronicle.bytes

Interface BytesMarshallable

All Superinterfaces:

CommonMarshallable, ReadBytesMarshallable, WriteBytesMarshallable

All Known Implementing Classes:

BinaryIntArrayReference, BinaryLongArrayReference

public interface BytesMarshallable
extends ReadBytesMarshallable, WriteBytesMarshallable

Serialisable object that reads and writes its state directly to a Bytes stream. Default implementations delegate to BytesUtil utilities. The interface is marked with DontChain to discourage chaining of implementations.

Method Summary

Modifier and Type	Method and Description
default String	$toString() Dumps the binary form of this object as a hex string for debugging.
default void	readMarshallable(BytesIn<?> bytes) Reads data from the provided BytesIn object.
default boolean	usesSelfDescribingMessage() Indicates whether the serialised form should contain enough metadata for a generic parser to understand it without prior knowledge of the concrete type.
default void	writeMarshallable(BytesOut<?> bytes) Writes this object's state to bytes using a custom binary format.

Method Detail

usesSelfDescribingMessage

default boolean usesSelfDescribingMessage()

Indicates whether the serialised form should contain enough metadata for a generic parser to understand it without prior knowledge of the concrete type.

Specified by:

usesSelfDescribingMessage in interface CommonMarshallable

Returns:

true by default

readMarshallable

default void readMarshallable(BytesIn<?> bytes)
                       throws net.openhft.chronicle.core.io.IORuntimeException,
                              BufferUnderflowException,
                              IllegalStateException,
                              net.openhft.chronicle.core.io.InvalidMarshallableException

Reads data from the provided BytesIn object. Implementations of this method are responsible for handling their own data reading logic based on the structure of the data they expect to read.

Note: Implementations are also responsible for calling Validatable.validate() when necessary.

Specified by:

readMarshallable in interface ReadBytesMarshallable

Parameters:

bytes - The BytesIn instance to read data from.

Throws:

net.openhft.chronicle.core.io.IORuntimeException - If an I/O error occurs during reading.

BufferUnderflowException - If there is not enough data in the buffer to read.

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

net.openhft.chronicle.core.io.InvalidMarshallableException - If there is a problem with marshalling data, such as incorrect format or type.

IllegalStateException

writeMarshallable

default void writeMarshallable(BytesOut<?> bytes)
                        throws IllegalStateException,
                               BufferOverflowException,
                               BufferUnderflowException,
                               ArithmeticException,
                               net.openhft.chronicle.core.io.InvalidMarshallableException

Writes this object's state to bytes using a custom binary format. Implementations may validate their state prior to writing and throw InvalidMarshallableException if invalid.

Specified by:

writeMarshallable in interface WriteBytesMarshallable

Parameters:

bytes - the target stream

Throws:

net.openhft.chronicle.core.io.ClosedIllegalStateException - if the resource has been released or closed

net.openhft.chronicle.core.io.ThreadingIllegalStateException - if accessed by multiple threads in an unsafe way

BufferOverflowException - if there is insufficient space in the buffer

net.openhft.chronicle.core.io.InvalidMarshallableException - if the object is not in a valid state for serialisation

IllegalStateException

BufferUnderflowException

ArithmeticException

$toString

default String $toString()

Dumps the binary form of this object as a hex string for debugging.