com.syntaxphoenix.syntaxapi.utils.io

Interface Serializer<T>

Type Parameters:

T - the type of object which is to be serialized

All Known Subinterfaces:

TextSerializer<T>

public interface Serializer<T>

Throwaway object for writing objects to files.

The serializer interface is designed as a utility interface, giving each implementation several methods for serializing to URL's, files, byte arrays and more.

The only method to be implemented is toStream(Object, OutputStream) which writes an object into a generic output stream.

Method Summary

Modifier and Type	Method and Description
default byte[]	toBytes(T object) Writes the object into bytes byte[] using a ByteArrayOutputStream with unset capacity.
default byte[]	toBytes(T object, int capacity) Writes the object into bytes byte[] using a ByteArrayOutputStream with set capacity.
default void	toFile(T object, File file) Writes the object into a File using a FileOutputStream.
void	toStream(T object, OutputStream stream) Writes the object into a OutputStream.

Method Detail

toStream

void toStream(T object,
              OutputStream stream)
       throws IOException

Writes the object into a OutputStream.

Parameters:

object - the object

stream - the output stream

Throws:

IOException - if an I/O error occurs

toFile

default void toFile(T object,
                    File file)
             throws IOException

Writes the object into a File using a FileOutputStream.

Parameters:

object - the object

file - the file

Throws:

IOException - if an I/O error occurs

toBytes

default byte[] toBytes(T object,
                       int capacity)
                throws IOException

Writes the object into bytes byte[] using a ByteArrayOutputStream with set capacity.

Parameters:

object - the object

capacity - the byte buffer capacity used by the stream

Returns:

a byte array containing the serialized object

Throws:

IOException - if an I/O error occurs

See Also:

ByteArrayOutputStream(int)

toBytes

default byte[] toBytes(T object)
                throws IOException

Writes the object into bytes byte[] using a ByteArrayOutputStream with unset capacity.

Parameters:

object - the object

Returns:

a byte array containing the serialized object

Throws:

IOException - if an I/O error occurs

See Also:

ByteArrayOutputStream()