net.openhft.chronicle.bytes

Interface BytesMarshallable

All Superinterfaces:

CommonMarshallable, ReadBytesMarshallable, WriteBytesMarshallable

All Known Implementing Classes:

BinaryIntArrayReference, BinaryLongArrayReference

public interface BytesMarshallable
extends ReadBytesMarshallable, WriteBytesMarshallable

An interface for objects that can be read from and written to bytes in a streaming manner. The object's internal state can be directly serialized and deserialized from a BytesIn or BytesOut object. This interface extends the ReadBytesMarshallable and WriteBytesMarshallable interfaces, which provide methods for reading and writing Marshallable objects, respectively.

Classes implementing this interface should override the methods to provide their own custom serialization and deserialization logic. If not overridden, the default methods use the BytesUtil's methods for reading and writing Marshallable objects.

The $toString method provides a default implementation for creating a string representation of the object in a hexadecimal format.

Implementations of this interface must not be chained as suggested by the DontChain annotation.

Method Summary

Modifier and Type	Method and Description
default String	$toString() Provides a string representation of this object in a hexadecimal format.
default void	readMarshallable(BytesIn<?> bytes) Reads the state of this object from the bytes.
default boolean	usesSelfDescribingMessage() Indicates whether the object uses self-describing messages for serialization.
default void	writeMarshallable(BytesOut<?> bytes) Writes the state of this object to the bytes.

Method Detail

usesSelfDescribingMessage

default boolean usesSelfDescribingMessage()

Indicates whether the object uses self-describing messages for serialization. By default, this method returns false.

Specified by:

usesSelfDescribingMessage in interface CommonMarshallable

Returns:

false by default.

readMarshallable

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

Reads the state of this object from the bytes.

Specified by:

readMarshallable in interface ReadBytesMarshallable

Parameters:

bytes - the BytesIn object to read from.

Throws:

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

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

net.openhft.chronicle.core.io.InvalidMarshallableException - If the object cannot be read due to invalid data.

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

IllegalStateException

writeMarshallable

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

Writes the state of this object to the bytes.

Specified by:

writeMarshallable in interface WriteBytesMarshallable

Parameters:

bytes - the BytesOut object to write to.

Throws:

BufferOverflowException - If there is not enough space in the buffer.

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

ArithmeticException - If there is an arithmetic error.

net.openhft.chronicle.core.io.InvalidMarshallableException - If the object cannot be written due to invalid data.

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

IllegalStateException

$toString

default String $toString()

Provides a string representation of this object in a hexadecimal format.

Returns:

the hexadecimal string representation of this object.