org.atlanmod.commons.io.serializer

Interface BinarySerializer<T>

Type Parameters:

T - the type of (de)serialized objects

All Superinterfaces:

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

All Known Implementing Classes:

AbstractBinarySerializer

@ParametersAreNonnullByDefault
public interface BinarySerializer<T>
extends Serializer<T,byte[]>, Serializable

An object that is responsible of Object to byte[] encoding and decoding.

Method Summary

Modifier and Type	Method and Description
T	deserialize(DataInput in) Reads and assembles an object of type T from the given in.
T	deserialize(InputStream is) Reads and assembles an object of type T from the given is.
void	serialize(T t, DataOutput out) Write an object of type T to the given out.
void	serialize(T t, OutputStream os) Write an object of type T to the given os.

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

convert, deserialize, revert, serialize

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

apply, compose, from, identity, reverse

Methods inherited from interface java.util.function.Function

andThen, compose

Method Detail

serialize

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

Write an object of type T to the given os.

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

Parameters:

t - the object to serialize

os - the output stream

Throws:

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

serialize

void serialize(T t,
               @WillNotClose
               DataOutput out)
        throws IOException

Write an object of type T to the given out.

Parameters:

t - the object to serialize

out - the output stream

Throws:

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

deserialize

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

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

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

Parameters:

is - the input stream

Returns:

the deserialized object

Throws:

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

deserialize

@Nonnull
T deserialize(@WillNotClose
                       DataInput in)
                throws IOException

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

Parameters:

in - the input stream

Returns:

the deserialized object

Throws:

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