|
Oracle® Coherence Java API Reference Release 3.7.1.0 E22843-01 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Marshaller
An interface that must be implemented by REST marshallers.
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 |
---|
static final java.lang.String FORMAT_OUTPUT
Method Detail |
---|
void marshal(java.lang.Object oValue, java.io.OutputStream out) throws java.io.IOException
oValue
- object to marshallout
- stream to write tojava.io.IOException
- if an error occurs during marshallingvoid marshalAsFragment(java.lang.Object oValue, java.io.OutputStream out) throws java.io.IOException
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)
.
oValue
- object to marshallout
- stream to write tojava.io.IOException
- if an error occurs during marshallingjava.lang.Object unmarshal(java.io.InputStream in) throws java.io.IOException
in
- stream to read fromjava.io.IOException
- if an error occurs during unmarshalling
|
Oracle® Coherence Java API Reference Release 3.7.1.0 E22843-01 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |