org.eclipse.persistence.oxm.record

Class JSONFormattedWriterRecord

java.lang.Object

org.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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map, Record

public class JSONFormattedWriterRecord
extends JSONWriterRecord

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);


See Also:

XMLMarshaller, Serialized Form

Nested Class Summary

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

AbstractRecord.NoEntry

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.XMLRecord

NIL

Fields inherited from class org.eclipse.persistence.internal.sessions.AbstractRecord

noEntry

Constructor Summary

Constructors

Constructor and Description
JSONFormattedWriterRecord()
JSONFormattedWriterRecord(java.io.Writer writer)
JSONFormattedWriterRecord(java.io.Writer writer, java.lang.String callbackName)

Method Summary

Modifier and Type	Method and Description
void	characters(java.lang.String value) INTERNAL:
void	element(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(XPathFragment xPathFragment, NamespaceResolver namespaceResolver) INTERNAL:
void	node(org.w3c.dom.Node node, NamespaceResolver namespaceResolver) Receive notification of a node.
void	openStartElement(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:

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, getTextWrapperFragment, getWriter, isWrapperAsCollectionName, marshalWithoutRootElement, namespaceDeclaration, namespaceDeclarations, nilComplex, nilSimple, node, setCallbackName, setMarshaller, setWriter, startPrefixMappings

Methods inherited from class org.eclipse.persistence.oxm.record.MarshalRecord

add, addGroupingElement, afterContainmentMarshal, beforeContainmentMarshal, clear, closeStartGroupingElements, endPrefixMapping, getCycleDetectionStack, getDocument, getDOM, getGroupingElements, getLocalName, getNamespaceURI, getPositionalNodes, getValueToWrite, openStartGroupingElements, predicateAttribute, put, removeGroupingElement, setGroupingElement, setSession, startPrefixMapping, transformToXML, writeHeader

Methods inherited from class org.eclipse.persistence.oxm.record.XMLRecord

attributeWithoutQName, contains, get, get, getCurrentObject, getDocPresPolicy, getIndicatingNoEntry, getLeafElementType, getMarshaller, getNamespaceResolver, getOwningObject, getSession, getUnmarshaller, hasCustomNamespaceMapper, hasEqualNamespaceResolvers, isNamespaceAware, isXOPPackage, put, resolveNamespacePrefix, setCurrentObject, setCustomNamespaceMapper, setDocPresPolicy, setEqualNamespaceResolvers, setLeafElementType, setLeafElementType, setNamespaceResolver, setOwningObject, setUnmarshaller, setXOPPackage

Methods inherited from class org.eclipse.persistence.internal.sessions.AbstractRecord

clone, containsKey, containsKey, containsKey, containsValue, elements, entrySet, get, getField, getFields, getIndicatingNoEntry, getValues, getValues, getValues, hasNullValueInFields, isEmpty, keys, keySet, mergeFrom, put, putAll, remove, remove, remove, replaceAt, setNullValueInFields, size, toString, values

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

JSONFormattedWriterRecord

public JSONFormattedWriterRecord()

JSONFormattedWriterRecord

public JSONFormattedWriterRecord(java.io.Writer writer)

JSONFormattedWriterRecord

public JSONFormattedWriterRecord(java.io.Writer writer,
                                 java.lang.String callbackName)

Method Detail

startDocument

public void startDocument(java.lang.String encoding,
                          java.lang.String version)

Description copied from class: JSONWriterRecord

INTERNAL:

Overrides:

startDocument in class JSONWriterRecord

Parameters:

encoding - The XML document will be encoded using this encoding.

version - This specifies the version of XML.

endDocument

public void endDocument()

INTERNAL:

Overrides:

endDocument in class JSONWriterRecord

openStartElement

public void openStartElement(XPathFragment xPathFragment,
                             NamespaceResolver namespaceResolver)

INTERNAL:

Overrides:

openStartElement in class JSONWriterRecord

Parameters:

xPathFragment - 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).

element

public void element(XPathFragment frag)

INTERNAL:

Overrides:

element in class JSONWriterRecord

Parameters:

frag - The XPathFragment of the element

endElement

public void endElement(XPathFragment xPathFragment,
                       NamespaceResolver namespaceResolver)

INTERNAL:

Overrides:

endElement in class JSONWriterRecord

Parameters:

xPathFragment - 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).

startCollection

public void startCollection()

Description copied from class: MarshalRecord

This method is used to inform the MarshalRecord that the element events it is about to receive are part of a collection.

Overrides:

startCollection in class JSONWriterRecord

See Also:

endCollection

endCollection

public void endCollection()

Description copied from class: MarshalRecord

This method is used to inform the MarshalRecord that it is done receiving element events that are part of a collection.

Overrides:

endCollection in class JSONWriterRecord

See Also:

startCollection

characters

public void characters(java.lang.String value)

INTERNAL:

Overrides:

characters in class JSONWriterRecord

Parameters:

value - This is the entire value of the text node.

node

public void node(org.w3c.dom.Node node,
                 NamespaceResolver namespaceResolver)

Receive notification of a node.

Overrides:

node in class MarshalRecord

Parameters:

node - The Node to be added to the document

namespaceResolver - The NamespaceResolver can be used to resolve the namespace URI/prefix of the node