org.axonframework.serializer

Interface Serializer<T>

Type Parameters:

T - The base type the serializer handles.

All Known Implementing Classes:

GenericXStreamSerializer, LegacyEventSerializerWrapper, XStreamEventSerializer, XStreamSerializer

public interface Serializer<T>

Interface describing a serialization mechanism. Implementations can serialize objects of given type T to an output stream and read the object back in from an input stream.

Since:

1.2

Author:

Allard Buijze

Method Summary

Methods

Modifier and Type	Method and Description
T	deserialize(byte[] bytes) Deserializes the first object read from the given bytes.
T	deserialize(InputStream inputStream) Deserializes the first object read from the given inputStream.
byte[]	serialize(T object) Serialize the given object into a byte[].
void	serialize(T object, OutputStream outputStream) Serializes the given object to the given outputStream.

Method Detail

serialize

void serialize(T object,
             OutputStream outputStream)
               throws IOException

Serializes the given object to the given outputStream. This method does not close the outputStream after writing the object.

Parameters:

object - The object to serialize

outputStream - The outputStream to write the serialized data to

Throws:

IOException - when an error occurs while writing to the stream

serialize

byte[] serialize(T object)

Serialize the given object into a byte[].

Parameters:

object - The object to serialize

Returns:

the byte array representing the serialized object.

deserialize

T deserialize(InputStream inputStream)
              throws IOException

Deserializes the first object read from the given inputStream. The inputStream is not closed after reading. The resulting object instance is cast to the expected type.

Implementations are encouraged to only read the data needed for deserialization of the first encountered instance.

Parameters:

inputStream - the stream providing the serialized data

Returns:

the serialized object, cast to the expected type

Throws:

IOException - when an error occurs while reading from the stream

ClassCastException - if the first object in the stream is not an instance of <T>.

deserialize

T deserialize(byte[] bytes)

Deserializes the first object read from the given bytes. The bytes are not consumed from the array or modified in any way. The resulting object instance is cast to the expected type.

Parameters:

bytes - the bytes providing the serialized data

Returns:

the serialized object, cast to the expected type

Throws:

ClassCastException - if the first object in the stream is not an instance of <T>.