com.atlassian.marshalling.api

Interface Marshaller<T>

Type Parameters:

T - the type that can be converted

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
 @PublicSpi
public interface Marshaller<T>

Represents the ability to convert an object, of type T, to an array of bytes.

Notes:

• Data versioning is the responsibility of the implementation.
• The implementation must be multi-thread safe.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
byte[]	marshallToBytes(T obj) Responsible for converting a object into an array of bytes.

Method Detail

marshallToBytes

byte[] marshallToBytes(T obj)
                throws MarshallingException

Responsible for converting a object into an array of bytes.

Parameters:

obj - the object to be converted.

Returns:

the array of bytes representing data

Throws:

MarshallingException - if unable to perform the conversion. Implementors should not wrap all exceptions, like NullPointerException, with this exception. It should be used to report specific errors related to doing the marshalling, such as a checked exception like IOException.