com.atlassian.marshalling.api

Interface Unmarshaller<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 Unmarshaller<T>

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

Notes:

• Data versioning is the responsibility of the implementation.
• The instances returned by unmarshallFrom(byte[]) for equal input byte arrays should match when compared using the Object.equals(Object) method, but it's not a hard requirement.
• The implementation must be multi-thread safe.

Since:

1.0

Method Summary

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

Method Detail

unmarshallFrom

T unmarshallFrom(byte[] raw)
          throws MarshallingException

Responsible for converting an array of bytes into an object.

Parameters:

raw - the array of bytes to be converted.

Returns:

the object represented by raw

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 unmarshalling, such as a checked exception like IOException.