Package org.atlanmod.commons.io.serializer

Class AbstractBinarySerializer<T>

java.lang.Object

org.atlanmod.commons.io.serializer.AbstractBinarySerializer<T>

Type Parameters:

T - the type of (de)serialized objects

All Implemented Interfaces:

Serializable, Function<T,byte[]>, Converter<T,byte[]>, BinarySerializer<T>, Serializer<T,byte[]>

@ParametersAreNonnullByDefault
public abstract class AbstractBinarySerializer<T>
extends Object
implements BinarySerializer<T>

An abstract BinarySerializer for objects of type T.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
AbstractBinarySerializer()

Method Summary

Modifier and Type	Method	Description
T	deserialize(byte[] data)	Reads and assembles an object of type T from the given data.
T	deserialize(InputStream is)	Reads and assembles an object of type T from the given is.
byte[]	serialize(T t)	Write an object of type T into its basic representation.
void	serialize(T t, OutputStream os)	Write an object of type T to the given os.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.atlanmod.commons.io.serializer.BinarySerializer

deserialize, serialize

Methods inherited from interface org.atlanmod.commons.function.Converter

apply, reverse

Methods inherited from interface java.util.function.Function

andThen, compose

Methods inherited from interface org.atlanmod.commons.io.serializer.Serializer

convert, revert

Constructor Detail

AbstractBinarySerializer

public AbstractBinarySerializer()

Method Detail

serialize

@Nonnull
public byte[] serialize(T t)
                 throws IOException

Description copied from interface: Serializer

Write an object of type T into its basic representation.

Specified by:

serialize in interface Serializer<T,byte[]>

Parameters:

t - the object to serialize

Returns:

the serialized object

Throws:

IOException - if an I/O error occurs during the serialization

deserialize

@Nonnull
public T deserialize(byte[] data)
              throws IOException

Description copied from interface: Serializer

Reads and assembles an object of type T from the given data.

Specified by:

deserialize in interface Serializer<T,byte[]>

Parameters:

data - the basic representation of the object

Returns:

the deserialized object

Throws:

IOException - if an I/O error occurs during the deserialization

serialize

public void serialize(T t,
                      @WillNotClose
                      OutputStream os)
               throws IOException

Description copied from interface: BinarySerializer

Write an object of type T to the given os.

If the os also implements DataOutput, prefer using BinarySerializer.serialize(Object, DataOutput). This method will create a adapter on os before calling it.

Specified by:

serialize in interface BinarySerializer<T>

Parameters:

t - the object to serialize

os - the output stream

Throws:

IOException - if an I/O error occurs during the serialization

deserialize

@Nonnull
public T deserialize(@WillNotClose
                     InputStream is)
              throws IOException

Description copied from interface: BinarySerializer

Reads and assembles an object of type T from the given is.

If the is also implements DataInput, prefer using BinarySerializer.deserialize(DataInput). This method will create a adapter on is before calling it.

Specified by:

deserialize in interface BinarySerializer<T>

Parameters:

is - the input stream

Returns:

the deserialized object

Throws:

IOException - if an I/O error occurs during the deserialization