com.atlassian.vcache

Interface Marshaller<T>

Type Parameters:

T - the type that can be converted

@PublicSpi
public interface Marshaller<T>

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

Notes:

• The unmarshall(byte[]) method should only ever be passed data that was generated by calling the marshall(Object) method on an instance of Marshaller associated with a cache with the same name. However, the unmarshall(byte[]) should endeavour to be robust in the event of arbitrary data.
• Data versioning is the responsibility of the implementation.
• The instances returned by unmarshall(byte[]) for the same input byte array must match when compared using the Object.equals(Object) method.
• See the Data Considerations section in the ExternalCache documentation.
• The implementation must be multi-thread safe.

Since:

1.0

Method Summary

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

Method Detail

marshall

@Nonnull
byte[] marshall(T obj)
                  throws MarshallerException

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:

MarshallerException - if unable to perform the conversion

unmarshall

@Nonnull
T unmarshall(byte[] raw)
               throws MarshallerException

Responsible for converting an array of bytes into an object. The instances returned for the same input byte array must match when compared using the Object.equals(Object) method.

Parameters:

raw - the array of bytes to be converted.

Returns:

the object represented by raw

Throws:

MarshallerException - if unable to perform the conversion