Skip navigation links

com.tangosol.coherence.rest.io
Class AbstractMarshaller

java.lang.Object
com.tangosol.coherence.rest.io.AbstractMarshaller

All Implemented Interfaces:

Marshaller

Direct Known Subclasses:

JsonJacksonMarshaller, JsonJaxbMarshaller, XmlJaxbMarshaller

public abstract class AbstractMarshaller

extends java.lang.Object

implements Marshaller

Abstract base class for built-in marshallers.

Author:

as 2011.07.10

Field Summary

Fields inherited from interface com.tangosol.coherence.rest.io.Marshaller

FORMAT_OUTPUT

Constructor Summary

AbstractMarshaller(java.lang.Class clzRoot)
Construct a marshaller instance.

Method Summary

protected java.lang.Class	getRootClass() Return class of the root object this marshaller is for.
void	marshalAsFragment(java.lang.Object oValue, java.io.OutputStream out) Write the specified object into the given stream as a fragment.

Methods inherited from interface com.tangosol.coherence.rest.io.Marshaller

marshal, unmarshal

Constructor Detail

AbstractMarshaller

public AbstractMarshaller(java.lang.Class clzRoot)

Construct a marshaller instance.

Parameters:

clzRoot - class of the root object this marshaller is for

Method Detail

marshalAsFragment

public 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 Marshaller.marshal(Object, OutputStream).

Specified by:

marshalAsFragment in interface Marshaller

Parameters:

oValue - object to marshall

out - stream to write to

Throws:

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

getRootClass

protected java.lang.Class getRootClass()

Return class of the root object this marshaller is for.

Returns:

root object class

Skip navigation links