net.openhft.chronicle.bytes

Class BytesMarshaller<T>

java.lang.Object

net.openhft.chronicle.bytes.BytesMarshaller<T>

Type Parameters:

T - the type of the object to be marshaled.

public class BytesMarshaller<T>
extends Object

This class is used to marshal objects into bytes and unmarshal them from bytes. The object's fields are read and written in a streaming manner, with the ability to handle different types of fields. It uses a map to track the fields of the class and their corresponding values. This class makes use of the FieldAccess for actual field value extraction and setting.

This class also provides a method for extracting all fields from a class and its superclasses (except transient and static fields). All the fields are made accessible even if they are private, and are then stored in a map for future access.

Note: This class suppresses rawtypes and unchecked warnings.

Field Summary

Fields

Modifier and Type	Field and Description
static net.openhft.chronicle.core.util.ClassLocal<BytesMarshaller>	BYTES_MARSHALLER_CL Provides a ClassLocal instance for holding a unique BytesMarshaller for each class.

Constructor Summary

Constructors

Constructor and Description
BytesMarshaller(@NotNull Class<T> tClass) Constructs a BytesMarshaller for the specified class.

Method Summary

Modifier and Type	Method and Description
static void	getAllField(@NotNull Class<?> clazz, @NotNull Map<String,Field> map) Extracts all fields from the specified class and its superclasses and stores them in the provided map.
void	readMarshallable(ReadBytesMarshallable t, BytesIn<?> in) Reads the state of the given ReadBytesMarshallable object from the specified BytesIn.
void	writeMarshallable(WriteBytesMarshallable t, BytesOut<?> out) Writes the state of the given WriteBytesMarshallable object to the specified BytesOut.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

BYTES_MARSHALLER_CL

public static final net.openhft.chronicle.core.util.ClassLocal<BytesMarshaller> BYTES_MARSHALLER_CL

Provides a ClassLocal instance for holding a unique BytesMarshaller for each class.

Constructor Detail

BytesMarshaller

public BytesMarshaller(@NotNull
                       @NotNull Class<T> tClass)

Constructs a BytesMarshaller for the specified class.

Parameters:

tClass - the class for which the BytesMarshaller is to be created.

Method Detail

getAllField

public static void getAllField(@NotNull
                               @NotNull Class<?> clazz,
                               @NotNull
                               @NotNull Map<String,Field> map)

Extracts all fields from the specified class and its superclasses and stores them in the provided map. Only non-static and non-transient fields are considered.

Parameters:

clazz - the class from which to extract fields.

map - the map in which to store the fields.

readMarshallable

public void readMarshallable(ReadBytesMarshallable t,
                             BytesIn<?> in)
                      throws net.openhft.chronicle.core.io.InvalidMarshallableException

Reads the state of the given ReadBytesMarshallable object from the specified BytesIn.

Parameters:

t - the object to read into.

in - the BytesIn from which to read.

Throws:

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

writeMarshallable

public void writeMarshallable(WriteBytesMarshallable t,
                              BytesOut<?> out)
                       throws IllegalArgumentException,
                              net.openhft.chronicle.core.io.ClosedIllegalStateException,
                              BufferOverflowException,
                              BufferUnderflowException,
                              ArithmeticException,
                              net.openhft.chronicle.core.io.InvalidMarshallableException,
                              net.openhft.chronicle.core.io.ThreadingIllegalStateException

Writes the state of the given WriteBytesMarshallable object to the specified BytesOut.

Parameters:

t - the object to write.

out - the BytesOut to which to write.

Throws:

IllegalArgumentException - If a method is invoked with an illegal or inappropriate argument.

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

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.