|
EclipseLink 2.4.1, build 'v20121003-ad44345' API Reference | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.eclipse.persistence.internal.sessions.AbstractRecord
org.eclipse.persistence.oxm.record.XMLRecord
org.eclipse.persistence.oxm.record.MarshalRecord
org.eclipse.persistence.oxm.record.JSONWriterRecord
org.eclipse.persistence.oxm.record.JSONFormattedWriterRecord
public class JSONFormattedWriterRecord
Use this type of MarshalRecord when the marshal target is a Writer and the JSON should be formatted with carriage returns and indenting.
XMLContext xmlContext = new XMLContext("session-name");
XMLMarshaller xmlMarshaller = xmlContext.createMarshaller();
JSONFormattedWriterRecord jsonFormattedRecord = new JSONFormattedWriterRecord();
jsonFormattedWriterRecord.setWriter(myWriter);
xmlMarshaller.marshal(myObject, jsonFormattedWriterRecord);
If the marshal(Writer) and setMediaType(MediaType.APPLICATION_JSON) and setFormattedOutput(true) method is called on XMLMarshaller, then the Writer is automatically wrapped in a JSONFormattedWriterRecord.
XMLContext xmlContext = new XMLContext("session-name");
XMLMarshaller xmlMarshaller = xmlContext.createMarshaller();
xmlMarshaller.setMediaType(MediaType.APPLICATION_JSON);
xmlMarshaller.setFormattedOutput(true);
xmlMarshaller.marshal(myObject, myWriter);
XMLMarshaller,
Serialized Form| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from class org.eclipse.persistence.oxm.record.JSONWriterRecord |
|---|
JSONWriterRecord.JSONWriterRecordContentHandler, JSONWriterRecord.Level |
| Nested classes/interfaces inherited from class org.eclipse.persistence.oxm.record.MarshalRecord |
|---|
MarshalRecord.CycleDetectionStack<E> |
| Nested classes/interfaces inherited from class org.eclipse.persistence.internal.sessions.AbstractRecord |
|---|
org.eclipse.persistence.internal.sessions.AbstractRecord.EntrySet, org.eclipse.persistence.internal.sessions.AbstractRecord.KeySet, org.eclipse.persistence.internal.sessions.AbstractRecord.NoEntry, org.eclipse.persistence.internal.sessions.AbstractRecord.RecordEntry, org.eclipse.persistence.internal.sessions.AbstractRecord.RecordEntryIterator, org.eclipse.persistence.internal.sessions.AbstractRecord.RecordKeyIterator, org.eclipse.persistence.internal.sessions.AbstractRecord.RecordValuesIterator, org.eclipse.persistence.internal.sessions.AbstractRecord.ValuesSet |
| Nested classes/interfaces inherited from interface java.util.Map |
|---|
java.util.Map.Entry<K,V> |
| Field Summary |
|---|
| Fields inherited from class org.eclipse.persistence.oxm.record.JSONWriterRecord |
|---|
attributePrefix, characterEscapeHandler, charactersAllowed, encoder, isProcessingCData, isStartElementOpen, levels, NULL, space, writer |
| Fields inherited from class org.eclipse.persistence.oxm.record.MarshalRecord |
|---|
COLON_W_SCHEMA_NIL_ATTRIBUTE, textWrapperFragment, TRUE |
| Fields inherited from class org.eclipse.persistence.oxm.record.XMLRecord |
|---|
currentObject, equalNamespaceResolvers, hasCustomNamespaceMapper, marshaller, namespaceAware, namespaceResolver, NIL, session, unmarshaller |
| Fields inherited from class org.eclipse.persistence.internal.sessions.AbstractRecord |
|---|
fields, lookupField, noEntry, nullValueInFields, size, values |
| Constructor Summary | |
|---|---|
JSONFormattedWriterRecord()
|
|
| Method Summary | |
|---|---|
void |
characters(java.lang.String value)
INTERNAL: |
protected void |
closeComplex()
|
void |
element(org.eclipse.persistence.internal.oxm.XPathFragment frag)
INTERNAL: |
void |
endCollection()
This method is used to inform the MarshalRecord that it is done receiving element events that are part of a collection. |
void |
endDocument()
INTERNAL: |
void |
endElement(org.eclipse.persistence.internal.oxm.XPathFragment xPathFragment,
NamespaceResolver namespaceResolver)
INTERNAL: |
protected void |
endEmptyCollection()
|
void |
node(org.w3c.dom.Node node,
NamespaceResolver namespaceResolver)
Receive notification of a node. |
void |
openStartElement(org.eclipse.persistence.internal.oxm.XPathFragment xPathFragment,
NamespaceResolver namespaceResolver)
INTERNAL: |
void |
startCollection()
This method is used to inform the MarshalRecord that the element events it is about to receive are part of a collection. |
void |
startDocument(java.lang.String encoding,
java.lang.String version)
INTERNAL: |
protected void |
writeKey(org.eclipse.persistence.internal.oxm.XPathFragment xPathFragment)
|
| Methods inherited from class org.eclipse.persistence.oxm.record.JSONWriterRecord |
|---|
attribute, attribute, attribute, cdata, characters, characters, characters, closeStartElement, defaultNamespaceDeclaration, emptyAttribute, emptyCollection, emptyComplex, emptySimple, endPrefixMappings, getNamespaceSeparator, getStringForQName, getTextWrapperFragment, getWriter, marshalWithoutRootElement, namespaceDeclaration, namespaceDeclarations, nilComplex, nilSimple, setMarshaller, setWriter, startPrefixMappings, writeValue |
| Methods inherited from class org.eclipse.persistence.internal.sessions.AbstractRecord |
|---|
clone, containsKey, containsKey, containsKey, containsValue, elements, entrySet, get, getField, getFields, getIndicatingNoEntry, getLookupField, getValues, getValues, getValues, hasNullValueInFields, isEmpty, keys, keySet, mergeFrom, put, putAll, remove, remove, remove, replaceAt, resetSize, setFields, setNullValueInFields, setValues, size, toString, values |
| Methods inherited from class java.lang.Object |
|---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface java.util.Map |
|---|
equals, hashCode |
| Constructor Detail |
|---|
public JSONFormattedWriterRecord()
| Method Detail |
|---|
public void startDocument(java.lang.String encoding,
java.lang.String version)
JSONWriterRecord
startDocument in class JSONWriterRecordencoding - The XML document will be encoded using this encoding.version - This specifies the version of XML.public void endDocument()
endDocument in class JSONWriterRecord
protected void closeComplex()
throws java.io.IOException
closeComplex in class JSONWriterRecordjava.io.IOException
public void openStartElement(org.eclipse.persistence.internal.oxm.XPathFragment xPathFragment,
NamespaceResolver namespaceResolver)
openStartElement in class JSONWriterRecordxPathFragment - The XPathFragment contains the name and prefix
information about the XML element being ended.namespaceResolver - The NamespaceResolver can be used to resolve the
namespace URI for the namespace prefix held by the XPathFragment (if
required).public void element(org.eclipse.persistence.internal.oxm.XPathFragment frag)
element in class JSONWriterRecordfrag - The XPathFragment of the element
public void endElement(org.eclipse.persistence.internal.oxm.XPathFragment xPathFragment,
NamespaceResolver namespaceResolver)
endElement in class JSONWriterRecordxPathFragment - The XPathFragment contains the name and prefix
information about the XML element being ended.namespaceResolver - The NamespaceResolver can be used to resolve the
namespace URI for the namespace prefix held by the XPathFragment (if
required).public void startCollection()
MarshalRecord
startCollection in class JSONWriterRecordendCollectionprotected void endEmptyCollection()
endEmptyCollection in class JSONWriterRecordpublic void endCollection()
MarshalRecord
endCollection in class JSONWriterRecordstartCollectionpublic void characters(java.lang.String value)
characters in class JSONWriterRecordvalue - This is the entire value of the text node.
public void node(org.w3c.dom.Node node,
NamespaceResolver namespaceResolver)
node in class JSONWriterRecordnode - The Node to be added to the documentnamespaceResolver - The NamespaceResolver can be used to resolve the
namespace URI/prefix of the node
protected void writeKey(org.eclipse.persistence.internal.oxm.XPathFragment xPathFragment)
throws java.io.IOException
writeKey in class JSONWriterRecordjava.io.IOException
|
EclipseLink 2.4.1, build 'v20121003-ad44345' API Reference | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||