cz.ues.platform.persistence.marshalling

Interface Marshaller

@UESComponent
public interface Marshaller

Component for marshalling and unmarshalling objects to various media types.

Since:

UES7-06

Method Summary

Methods

Modifier and Type	Method and Description
MarshallingContext	createContext(MediaType aMediaType) Creates context for specified media type.
boolean	isSupported(java.lang.Class<?> aClass, MediaType aMediaType) Returns whether it's possible to (un)marshal value of class aClass to/from media type aMediaType.
void	marshal(java.lang.Object aObject, java.io.OutputStream aOutput, MarshallingContext aContext) Performs marshalling of aObject into aOutput stream using specified context.
void	marshal(java.lang.Object aObject, java.io.OutputStream aOutput, MediaType aMediaType) Performs marshalling of aObject into aOutput stream in specified media type.
<T> T	unmarshal(java.lang.Class<T> aClass, java.io.InputStream aInput, MarshallingContext aContext) Performs unmarshalling of an object of class aClass from aInput stream using specified context.
<T> T	unmarshal(java.lang.Class<T> aClass, java.io.InputStream aInput, MediaType aMediaType) Performs unmarshalling of an object of class aClass from aInput stream which contains data in specified media type format.

Method Detail

createContext

MarshallingContext createContext(MediaType aMediaType)

Creates context for specified media type. It might be necessary to cast the context to more specific type, e.g. if creating context for MediaType.APPLICATION_XML, it is possible to cast the context to XMLMarshallingContext.

Parameters:

aMediaType - The media type.

Returns:

Created context.

Since:

UES7-06

isSupported

boolean isSupported(java.lang.Class<?> aClass,
MediaType aMediaType)

Returns whether it's possible to (un)marshal value of class aClass to/from media type aMediaType.

Parameters:

aClass - The class.

aMediaType - The media type.

Returns:

Whether (un)marshalling is possible.

Since:

UES7-06

marshal

void marshal(java.lang.Object aObject,
java.io.OutputStream aOutput,
MediaType aMediaType)

Performs marshalling of aObject into aOutput stream in specified media type.

Note that using this method is effectively the same as calling:

marshaller.marshal(aObject, aOutput, marshaller.createContext(aMediaType));

Parameters:

aObject - The object to marshal.

aOutput - The output stream.

aMediaType - The media type.

Since:

UES7-06

marshal

void marshal(java.lang.Object aObject,
java.io.OutputStream aOutput,
MarshallingContext aContext)

Performs marshalling of aObject into aOutput stream using specified context.

Parameters:

aObject - The object to marshal.

aOutput - The output stream.

aContext - The context.

Since:

UES7-06

unmarshal

<T> T unmarshal(java.lang.Class<T> aClass,
java.io.InputStream aInput,
MediaType aMediaType)

Performs unmarshalling of an object of class aClass from aInput stream which contains data in specified media type format.

Note that using this method is effectively the same as calling:

marshaller.unmarshal(aClass, aInput, marshaller.createContext(aMediaType));

Type Parameters:

T - The type of the unmarshalled object.

Parameters:

aClass - The class of the unmarshalled object.

aInput - The input stream to unmarshal from.

aMediaType - The media type.

Returns:

The unmarshalled object.

Since:

UES7-06

unmarshal

<T> T unmarshal(java.lang.Class<T> aClass,
java.io.InputStream aInput,
MarshallingContext aContext)

Performs unmarshalling of an object of class aClass from aInput stream using specified context.

Type Parameters:

T - The type of the unmarshalled object.

Parameters:

aClass - The class of the unmarshalled object.

aInput - The input stream to unmarshal from.

aContext - The context.

Returns:

The unmarshalled object.

Since:

UES7-06