me.zeroeightsix.fiber.api.serialization

Interface Serializer<T>

Type Parameters:

T - the type of serialized objects processed by this serializer

All Known Implementing Classes:

JanksonSerializer

public interface Serializer<T>

A Serializer serializes and deserializes data from a certain format into and from Nodes

See Also:

ConfigTree, JanksonSerializer

Method Summary

Modifier and Type	Method and Description
T	deserialize(ConfigTree tree, java.io.InputStream in) Deserializes data from an InputStream into a config tree.
T	deserialize(ConfigTree tree, T element) Deserializes an intermediate element into a config tree.
FiberId	getIdentifier()
T	serialize(ConfigTree tree) Serializes a config tree.
default void	serialize(ConfigTree tree, java.io.OutputStream out) Serializes a config tree and writes it to an OutputStream.
void	serialize(ConfigTree tree, T additionalData, java.io.OutputStream out) Serializes a config tree and writes it to an OutputStream.

Method Detail

getIdentifier

FiberId getIdentifier()

deserialize

T deserialize(ConfigTree tree,
              java.io.InputStream in)
       throws FiberException,
              java.io.IOException

Deserializes data from an InputStream into a config tree.

If the serialized tree has elements not present in the actual node, they will be collected as a separate data structure and returned.

Parameters:

tree - the node to deserialize

in - the serialized data for the node

Returns:

the unprocessed elements, in the same format as the input data

Throws:

FiberException

java.io.IOException

deserialize

T deserialize(ConfigTree tree,
              T element)
       throws FiberException

Deserializes an intermediate element into a config tree.

If the serialized tree has elements not present in the actual node, they will be collected as a separate data structure and returned.

Parameters:

tree - the node to deserialize

element - the serialized data for the node

Returns:

the unprocessed elements, in the same format as the input data

Throws:

FiberException

serialize

default void serialize(ConfigTree tree,
                       java.io.OutputStream out)
                throws FiberException,
                       java.io.IOException

Serializes a config tree and writes it to an OutputStream.

Parameters:

tree - the node to serialize

out - the stream to which the serialized data is to be written

Throws:

FiberException

java.io.IOException

serialize

void serialize(ConfigTree tree,
               @Nullable
               T additionalData,
               java.io.OutputStream out)
        throws FiberException,
               java.io.IOException

Serializes a config tree and writes it to an OutputStream.

The caller may pass in additional data to be appended to the serialized tree. In case of conflict between the serialized tree and the additional data (eg. map representation with conflicting keys), the conflicting data from the serialized tree gets overwritten.

The additionalData may be used with the leftovers from deserialize(ConfigTree, InputStream) to inject back unrecognized nodes.

Parameters:

tree - the node to serialize

additionalData - data to append to the serialized tree

out - the stream to which the serialized data is to be written

Throws:

FiberException

java.io.IOException

serialize

T serialize(ConfigTree tree)
     throws FiberException

Serializes a config tree.

Parameters:

tree - the node to serialize

Returns:

the serialized data for the node

Throws:

FiberException