net.openhft.lang.io.serialization

Interface ObjectSerializer

All Superinterfaces:

Serializable

All Known Implementing Classes:

BytesMarshallableSerializer, JDKObjectSerializer, JDKZObjectSerializer

public interface ObjectSerializer
extends Serializable

Abstracts serialization implementation, which at least should be able to serialize objects that Java built-in serialization is able serialize. In other words, ObjectSerializer abstracts Java serialization re-implementations and extensions. Bytes is used as core IO interface instead of InputStream + OutputStream pair, which Java built-in serialization use. However, note that Bytes could always be converted to these old interfaces by BytesCommon.inputStream() and BytesCommon.outputStream(), if needed.

The default fallback implementation is Java built-in serialization itself: JDKObjectSerializer.

Another provided implementation is BytesMarshallableSerializer, which basically extends built-in serialization with some improvements. For example, it could benefit if objects implement BytesMarshallable interface the same way as built-in serialization benefit if objects implement Externalizable. See BytesMarshallableSerializer docs for more information.

This interface is supposed to be implemented to plug such third-party serialization re-implementations, as Kryo, fast-serialization, etc.

Method Summary

Methods

Modifier and Type	Method and Description
<T> T	readSerializable(Bytes bytes, Class<T> expectedClass, T object) Read an object
void	writeSerializable(Bytes bytes, Object object, Class expectedClass) write an object

Method Detail

writeSerializable

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

write an object

Parameters:

bytes - to write to

object - object to write

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

Throws:

IOException

readSerializable

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

Read an object

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