Skip navigation links

com.tangosol.coherence.rest.io
Interface Marshaller

All Known Implementing Classes:

AbstractMarshaller, JsonJacksonMarshaller, JsonJaxbMarshaller, KeyConverterAdapter, XmlJaxbMarshaller

public interface Marshaller

An interface that must be implemented by REST marshallers.

Author:

as 2011.07.10

Field Summary

static java.lang.String

FORMAT_OUTPUT The name of the system property that is used to determine whether the marshaller output should be formatted for human readability.

Method Summary

void	marshal(java.lang.Object oValue, java.io.OutputStream out) Write the specified object into the given stream.
void	marshalAsFragment(java.lang.Object oValue, java.io.OutputStream out) Write the specified object into the given stream as a fragment.
java.lang.Object	unmarshal(java.io.InputStream in) Read an object from the specified stream.

Field Detail

FORMAT_OUTPUT

static final java.lang.String FORMAT_OUTPUT

The name of the system property that is used to determine whether the marshaller output should be formatted for human readability.

See Also:

Constant Field Values

Method Detail

marshal

void marshal(java.lang.Object oValue,
             java.io.OutputStream out)
             throws java.io.IOException

Write the specified object into the given stream.

Parameters:

oValue - object to marshall

out - stream to write to

Throws:

java.io.IOException - if an error occurs during marshalling

marshalAsFragment

void marshalAsFragment(java.lang.Object oValue,
                       java.io.OutputStream out)
                       throws java.io.IOException

Write the specified object into the given stream as a fragment.

This method is called when marshalling collections of objects, as marshalling behavior might differ when an object is serialized directly or as element of a collection.

For example, when marshalling a collection of objects into XML, you need to ensure that the XML declaration is emmitted only once, not for each object in the collection.

In cases where there is no difference in output between fragments and full objects (JSON, for example), this method could simply delegate to marshal(Object, OutputStream).

Parameters:

oValue - object to marshall

out - stream to write to

Throws:

java.io.IOException - if an error occurs during marshalling

unmarshal

java.lang.Object unmarshal(java.io.InputStream in)
                           throws java.io.IOException

Read an object from the specified stream.

Parameters:

in - stream to read from

Returns:

unmarshalled object instance

Throws:

java.io.IOException - if an error occurs during unmarshalling

Skip navigation links