net.openhft.lang.io.serialization

Class BytesMarshallableSerializer

java.lang.Object

net.openhft.lang.io.serialization.BytesMarshallableSerializer

All Implemented Interfaces:

Serializable, ObjectSerializer

public class BytesMarshallableSerializer
extends Object
implements ObjectSerializer

An extension of built-in Java serialization, featuring special treatment of BytesMarshallable objects, compact String encoding and support of pluggable custom serializers for arbitrary classes.

BytesMarshallableSerializer could benefit if objects (either top-level serialized or nested fields) implement BytesMarshallable interface the same way as built-in serialization benefit if objects implement Externalizable (of cause, BytesMarshallableSerializer supports Externalizable too).

CharSequences, including Strings (either top-level serialized or nested fields) are serialized in UTF-8 encoding.

Custom per-class serializers are held by BytesMarshallerFactory, which could be passed via constructor or static factory create() method.

See Also:

create(BytesMarshallerFactory, ObjectSerializer), Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BytesMarshallableSerializer(BytesMarshallerFactory bytesMarshallerFactory, ObjectSerializer objectSerializer)

Method Summary

Methods

Modifier and Type	Method and Description
static ObjectSerializer	create()
static ObjectSerializer	create(BytesMarshallerFactory bytesMarshallerFactory, ObjectSerializer instance)
<T> T	readSerializable(Bytes bytes, Class<T> expectedClass, T object) Read an object
void	writeSerializable(Bytes bytes, Object object, Class expectedClass) write an object

Methods inherited from class java.lang.Object

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

Constructor Detail

BytesMarshallableSerializer

protected BytesMarshallableSerializer(BytesMarshallerFactory bytesMarshallerFactory,
                           ObjectSerializer objectSerializer)

Method Detail

writeSerializable

public void writeSerializable(Bytes bytes,
                     Object object,
                     Class expectedClass)
                       throws IOException

Description copied from interface: ObjectSerializer

write an object

Specified by:

writeSerializable in interface ObjectSerializer

Parameters:

bytes - to write to

object - object to write

expectedClass - which will be provided on read, can be null

Throws:

IOException

readSerializable

public <T> T readSerializable(@NotNull
                     Bytes bytes,
                     Class<T> expectedClass,
                     T object)
                   throws IOException,
                          ClassNotFoundException

Description copied from interface: ObjectSerializer

Read an object

Specified by:

readSerializable in interface ObjectSerializer

Parameters:

bytes - to read

expectedClass - proved when writing, can be null

object - to populate, can be null

Returns:

object read.

Throws:

IOException - if it not possible to serialize the object

ClassNotFoundException - if the expectedClass can not be created

create

public static ObjectSerializer create()

create

public static ObjectSerializer create(BytesMarshallerFactory bytesMarshallerFactory,
                      ObjectSerializer instance)