Module org.eclipse.persistence.core

Package org.eclipse.persistence.oxm.record

Class JSONWriterRecord

java.lang.Object

org.eclipse.persistence.internal.core.sessions.CoreAbstractRecord

org.eclipse.persistence.internal.oxm.record.AbstractMarshalRecordImpl<CoreAbstractSession,CoreField,XMLMarshaller,NamespaceResolver>

org.eclipse.persistence.oxm.record.MarshalRecord<XMLMarshaller>

org.eclipse.persistence.oxm.record.JSONWriterRecord

All Implemented Interfaces:

AbstractMarshalRecord<CoreAbstractSession,CoreField,XMLMarshaller,NamespaceResolver>, MarshalRecord<CoreAbstractSession,CoreField,XMLMarshaller,NamespaceResolver>, XMLRecord<CoreAbstractSession>

Direct Known Subclasses:

JSONFormattedWriterRecord

public class JSONWriterRecord
extends MarshalRecord<XMLMarshaller>

Use this type of MarshalRecord when the marshal target is a Writer and the JSON should not be formatted with carriage returns or indenting.

XMLContext xmlContext = new XMLContext("session-name");
XMLMarshaller xmlMarshaller = xmlContext.createMarshaller();
JSONRecord jsonWriterRecord = new JSONWriterRecord();
jsonWriterRecord.setWriter(myWriter);
xmlMarshaller.marshal(myObject, jsonWriterRecord);


If the marshal(Writer) and setMediaType(MediaType.APPLICATION_JSON) and setFormattedOutput(false) method is called on XMLMarshaller, then the Writer is automatically wrapped in a JSONWriterRecord.

XMLContext xmlContext = new XMLContext("session-name");
XMLMarshaller xmlMarshaller = xmlContext.createMarshaller();
xmlMarshaller.setMediaType(MediaType.APPLICATION_JSON); xmlMarshaller xmlMarshaller.setFormattedOutput(false);
xmlMarshaller.marshal(myObject, myWriter);


See Also:

• XMLMarshaller

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	JSONWriterRecord.JSONWriterRecordContentHandler	This class will typically be used in conjunction with an XMLFragmentReader.
protected static class	JSONWriterRecord.Level	Instances of this class are used to maintain state about the current level of the JSON message being marshalled.
protected static interface	JSONWriterRecord.Output
protected static class	JSONWriterRecord.OutputStreamOutput

Nested classes/interfaces inherited from interface org.eclipse.persistence.internal.oxm.record.MarshalRecord

MarshalRecord.CycleDetectionStack<E>

Nested classes/interfaces inherited from interface org.eclipse.persistence.internal.oxm.record.XMLRecord

XMLRecord.Nil

Field Summary

Fields

Modifier and Type	Field	Description
protected String	attributePrefix
protected String	callbackName
protected CharacterEscapeHandler	characterEscapeHandler
protected boolean	charactersAllowed
protected CharsetEncoder	encoder
protected boolean	isProcessingCData
protected JSONWriterRecord.Level	level
protected static final String	NULL
protected JSONWriterRecord.Output	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.internal.oxm.record.AbstractMarshalRecordImpl

equalNamespaceResolvers, hasCustomNamespaceMapper, marshaller, namespaceAware, namespaceResolver, session

Fields inherited from interface org.eclipse.persistence.internal.oxm.record.XMLRecord

DEFAULT_ATTRIBUTE_GROUP, NIL

Constructor Summary

Constructors

Constructor	Description
JSONWriterRecord()
JSONWriterRecord(OutputStream outputStream)
JSONWriterRecord(OutputStream outputStream, String callbackName)
JSONWriterRecord(Writer writer)
JSONWriterRecord(Writer writer, String callbackName)

Method Summary

Modifier and Type	Method	Description
void	attribute(String namespaceURI, String localName, String qName, String value)	INTERNAL:
void	attribute(XPathFragment xPathFragment, NamespaceResolver namespaceResolver, Object value, QName schemaType)	Convert the value if necessary and write out the attribute and converted value.
void	attribute(XPathFragment xPathFragment, NamespaceResolver namespaceResolver, String value)	INTERNAL:
void	cdata(String value)	INTERNAL:
void	characters(String value)	INTERNAL:
void	characters(String value, boolean isString, boolean isAttribute)	INTERNAL:
void	characters(QName schemaType, Object value, String mimeType, boolean isCDATA)	Convert the value if necessary and write out the converted value.
void	characters(QName schemaType, Object value, String mimeType, boolean isCDATA, boolean isAttribute)
protected void	closeComplex()
void	closeStartElement()	INTERNAL:
void	defaultNamespaceDeclaration(String defaultNamespace)	Add the defaultNamespace declaration
void	element(XPathFragment frag)	INTERNAL:
void	emptyAttribute(XPathFragment xPathFragment, NamespaceResolver namespaceResolver)	Used when an nil attribute should be written
boolean	emptyCollection(XPathFragment xPathFragment, NamespaceResolver namespaceResolver, boolean openGrouping)	Handle marshal of an empty collection.
void	emptyComplex(XPathFragment xPathFragment, NamespaceResolver namespaceResolver)	Used when an empty complex item should be written
void	emptySimple(NamespaceResolver namespaceResolver)	Used when an empty simple value should be written
protected void	endCallback()
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:
protected void	endEmptyCollection()
void	endPrefixMappings(NamespaceResolver namespaceResolver)	INTERNAL: override so we don't iterate over namespaces when endPrefixMapping doesn't do anything
void	flush()
void	forceValueWrapper()
char	getNamespaceSeparator()	INTERNAL: The character used to separate the prefix and uri portions when namespaces are present
protected String	getStringForQName(QName qName)
XPathFragment	getTextWrapperFragment()	INTERNAL: The optional fragment used to wrap the text() mappings
Writer	getWriter()	Return the Writer that the object will be marshalled to.
boolean	isWrapperAsCollectionName()
void	marshalWithoutRootElement(ObjectBuilder treeObjectBuilder, Object object, Descriptor descriptor, Root root, boolean isXMLRoot)	INTERNAL:
void	namespaceDeclaration(String prefix, String namespaceURI)	Add the specified namespace declaration
void	namespaceDeclarations(NamespaceResolver namespaceResolver)	INTERNAL:
void	nilComplex(XPathFragment xPathFragment, NamespaceResolver namespaceResolver)	INTERNAL:
void	nilSimple(NamespaceResolver namespaceResolver)	INTERNAL:
void	node(Node node, NamespaceResolver namespaceResolver, String uri, String name)	Receive notification of a node.
void	openStartElement(XPathFragment xPathFragment, NamespaceResolver namespaceResolver)	INTERNAL:
void	setCallbackName(String callbackName)
void	setMarshaller(XMLMarshaller marshaller)	INTERNAL:
void	setWriter(Writer writer)	Set the Writer that the object will be marshalled to.
protected void	startCallback()	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(String encoding, String version)	INTERNAL:
void	startPrefixMappings(NamespaceResolver namespaceResolver)	INTERNAL: override so we don't iterate over namespaces when startPrefixMapping doesn't do anything
protected void	writeKey(XPathFragment xPathFragment)
protected void	writeListSeparator()
protected void	writeSeparator()
protected void	writeValue(String value, boolean isAttribute)	INTERNAL:

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

add, addGroupingElement, addPositionalNodes, afterContainmentMarshal, beforeContainmentMarshal, clear, closeStartGroupingElements, endPrefixMapping, getCurrentAttributeGroup, getCycleDetectionStack, getDocument, getDOM, getGroupingElements, getLocalName, getNameForFragment, getNamespaceURI, getPositionalNodes, getPrefixBytes, getPrefixForFragment, getValueToWrite, node, openStartGroupingElements, popAttributeGroup, predicateAttribute, processNamespaceResolverForXSIPrefix, pushAttributeGroup, put, removeGroupingElement, setGroupingElement, setSession, startPrefixMapping, transformToXML, writeHeader

Methods inherited from class org.eclipse.persistence.internal.oxm.record.AbstractMarshalRecordImpl

addExtraNamespacesToNamespaceResolver, addXsiTypeAndClassIndicatorIfRequired, addXsiTypeAndClassIndicatorIfRequired, attributeWithoutQName, getConversionManager, getLeafElementType, getMarshaller, getNamespaceResolver, getOwningObject, getSession, hasCustomNamespaceMapper, hasEqualNamespaceResolvers, isNamespaceAware, isXOPPackage, removeExtraNamespacesFromNamespaceResolver, resolveNamespacePrefix, setCustomNamespaceMapper, setEqualNamespaceResolvers, setLeafElementType, setLeafElementType, setNamespaceResolver, setOwningObject, setXOPPackage, writeXsiTypeAttribute, writeXsiTypeAttribute

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.eclipse.persistence.internal.oxm.record.AbstractMarshalRecord

addExtraNamespacesToNamespaceResolver, addXsiTypeAndClassIndicatorIfRequired, addXsiTypeAndClassIndicatorIfRequired, getLeafElementType, getMarshaller, getNamespaceResolver, getOwningObject, hasEqualNamespaceResolvers, isNamespaceAware, resolveNamespacePrefix, setCustomNamespaceMapper, setEqualNamespaceResolvers, setLeafElementType, setNamespaceResolver, setOwningObject, setXOPPackage, writeXsiTypeAttribute, writeXsiTypeAttribute

Methods inherited from interface org.eclipse.persistence.internal.oxm.record.MarshalRecord

attributeWithoutQName, hasCustomNamespaceMapper, isXOPPackage, removeExtraNamespacesFromNamespaceResolver, setLeafElementType

Methods inherited from interface org.eclipse.persistence.internal.oxm.record.XMLRecord

getConversionManager, getSession

Field Details

isProcessingCData

protected boolean isProcessingCData

NULL

protected static final String NULL

See Also:

• Constant Field Values

attributePrefix

protected String attributePrefix

charactersAllowed

protected boolean charactersAllowed

encoder

protected CharsetEncoder encoder

characterEscapeHandler

protected CharacterEscapeHandler characterEscapeHandler

callbackName

protected String callbackName

writer

protected JSONWriterRecord.Output writer

level

protected JSONWriterRecord.Level level

Constructor Details

JSONWriterRecord

public JSONWriterRecord()

JSONWriterRecord

public JSONWriterRecord(OutputStream outputStream)

JSONWriterRecord

public JSONWriterRecord(OutputStream outputStream,
 String callbackName)

JSONWriterRecord

public JSONWriterRecord(Writer writer)

JSONWriterRecord

public JSONWriterRecord(Writer writer,
 String callbackName)

Method Details

setCallbackName

public void setCallbackName(String callbackName)

setMarshaller

public void setMarshaller(XMLMarshaller marshaller)

INTERNAL:

Specified by:

setMarshaller in interface AbstractMarshalRecord<CoreAbstractSession,CoreField,XMLMarshaller,NamespaceResolver>

Specified by:

setMarshaller in interface MarshalRecord<CoreAbstractSession,CoreField,XMLMarshaller,NamespaceResolver>

Overrides:

setMarshaller in class AbstractMarshalRecordImpl<CoreAbstractSession,CoreField,XMLMarshaller,NamespaceResolver>

emptyCollection

public boolean emptyCollection(XPathFragment xPathFragment,
 NamespaceResolver namespaceResolver,
 boolean openGrouping)

Handle marshal of an empty collection.

Specified by:

emptyCollection in interface MarshalRecord<CoreAbstractSession,CoreField,XMLMarshaller,NamespaceResolver>

Overrides:

emptyCollection in class MarshalRecord<XMLMarshaller>

Parameters:

openGrouping - if grouping elements should be marshalled for empty collections

forceValueWrapper

public void forceValueWrapper()

Specified by:

forceValueWrapper in interface MarshalRecord<CoreAbstractSession,CoreField,XMLMarshaller,NamespaceResolver>

Overrides:

forceValueWrapper in class MarshalRecord<XMLMarshaller>

getWriter

public Writer getWriter()

Return the Writer that the object will be marshalled to.

Returns:

The marshal target.

setWriter

public void setWriter(Writer writer)

Set the Writer that the object will be marshalled to.

Parameters:

writer - The marshal target.

namespaceDeclaration

public void namespaceDeclaration(String prefix,
 String namespaceURI)

Description copied from class: MarshalRecord

Add the specified namespace declaration

Specified by:

namespaceDeclaration in interface AbstractMarshalRecord<CoreAbstractSession,CoreField,XMLMarshaller,NamespaceResolver>

Specified by:

namespaceDeclaration in interface MarshalRecord<CoreAbstractSession,CoreField,XMLMarshaller,NamespaceResolver>

Overrides:

namespaceDeclaration in class MarshalRecord<XMLMarshaller>

defaultNamespaceDeclaration

public void defaultNamespaceDeclaration(String defaultNamespace)

Description copied from class: MarshalRecord

Add the defaultNamespace declaration

Overrides:

defaultNamespaceDeclaration in class MarshalRecord<XMLMarshaller>

startDocument

public void startDocument(String encoding,
 String version)

INTERNAL:

Specified by:

startDocument in class MarshalRecord<XMLMarshaller>

Parameters:

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

version - This specifies the version of XML.

writeListSeparator

protected void writeListSeparator()
                           throws IOException

Throws:

IOException

writeSeparator

protected void writeSeparator()
                       throws IOException

Throws:

IOException

startCallback

protected void startCallback()
                      throws IOException

INTERNAL:

Throws:

IOException

endDocument

public void endDocument()

INTERNAL:

Specified by:

endDocument in class MarshalRecord<XMLMarshaller>

openStartElement

public void openStartElement(XPathFragment xPathFragment,
 NamespaceResolver namespaceResolver)

INTERNAL:

Specified by:

openStartElement in interface MarshalRecord<CoreAbstractSession,CoreField,XMLMarshaller,NamespaceResolver>

Overrides:

openStartElement in class MarshalRecord<XMLMarshaller>

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:

Specified by:

element in class MarshalRecord<XMLMarshaller>

Parameters:

frag - The XPathFragment of the element

attribute

public void attribute(String namespaceURI,
 String localName,
 String qName,
 String value)

INTERNAL:

Specified by:

attribute in interface AbstractMarshalRecord<CoreAbstractSession,CoreField,XMLMarshaller,NamespaceResolver>

Specified by:

attribute in interface MarshalRecord<CoreAbstractSession,CoreField,XMLMarshaller,NamespaceResolver>

Specified by:

attribute in class MarshalRecord<XMLMarshaller>

Parameters:

namespaceURI - The namespace URI, if the attribute is not namespace qualified the value of this parameter wil be null.

localName - The local name of the attribute.

qName - The qualified name of the attribute.

value - This is the complete value for the attribute.

attribute

public void attribute(XPathFragment xPathFragment,
 NamespaceResolver namespaceResolver,
 String value)

INTERNAL:

Specified by:

attribute in interface MarshalRecord<CoreAbstractSession,CoreField,XMLMarshaller,NamespaceResolver>

Specified by:

attribute in class MarshalRecord<XMLMarshaller>

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

value - This is the complete value for the attribute.

startPrefixMappings

public void startPrefixMappings(NamespaceResolver namespaceResolver)

INTERNAL: override so we don't iterate over namespaces when startPrefixMapping doesn't do anything

Overrides:

startPrefixMappings in class MarshalRecord<XMLMarshaller>

endPrefixMappings

public void endPrefixMappings(NamespaceResolver namespaceResolver)

INTERNAL: override so we don't iterate over namespaces when endPrefixMapping doesn't do anything

Overrides:

endPrefixMappings in class MarshalRecord<XMLMarshaller>

closeStartElement

public void closeStartElement()

INTERNAL:

Specified by:

closeStartElement in interface MarshalRecord<CoreAbstractSession,CoreField,XMLMarshaller,NamespaceResolver>

Specified by:

closeStartElement in class MarshalRecord<XMLMarshaller>

endElement

public void endElement(XPathFragment xPathFragment,
 NamespaceResolver namespaceResolver)

INTERNAL:

Specified by:

endElement in interface MarshalRecord<CoreAbstractSession,CoreField,XMLMarshaller,NamespaceResolver>

Specified by:

endElement in class MarshalRecord<XMLMarshaller>

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

closeComplex

protected void closeComplex()
                     throws IOException

Throws:

IOException

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.

Specified by:

startCollection in interface MarshalRecord<CoreAbstractSession,CoreField,XMLMarshaller,NamespaceResolver>

Overrides:

startCollection in class MarshalRecord<XMLMarshaller>

See Also:

• MarshalRecord.endCollection()

endEmptyCollection

protected void endEmptyCollection()

endCallback

protected void endCallback()
                    throws IOException

Throws:

IOException

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.

Specified by:

endCollection in interface MarshalRecord<CoreAbstractSession,CoreField,XMLMarshaller,NamespaceResolver>

Overrides:

endCollection in class MarshalRecord<XMLMarshaller>

See Also:

• MarshalRecord.startCollection()

characters

public void characters(String value)

INTERNAL:

Specified by:

characters in interface MarshalRecord<CoreAbstractSession,CoreField,XMLMarshaller,NamespaceResolver>

Specified by:

characters in class MarshalRecord<XMLMarshaller>

Parameters:

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

characters

public void characters(String value,
 boolean isString,
 boolean isAttribute)

INTERNAL:

attribute

public void attribute(XPathFragment xPathFragment,
 NamespaceResolver namespaceResolver,
 Object value,
 QName schemaType)

Description copied from class: MarshalRecord

Convert the value if necessary and write out the attribute and converted value.

Specified by:

attribute in interface MarshalRecord<CoreAbstractSession,CoreField,XMLMarshaller,NamespaceResolver>

Overrides:

attribute in class MarshalRecord<XMLMarshaller>

characters

public void characters(QName schemaType,
 Object value,
 String mimeType,
 boolean isCDATA)

Description copied from class: MarshalRecord

Convert the value if necessary and write out the converted value.

Specified by:

characters in interface MarshalRecord<CoreAbstractSession,CoreField,XMLMarshaller,NamespaceResolver>

Overrides:

characters in class MarshalRecord<XMLMarshaller>

characters

public void characters(QName schemaType,
 Object value,
 String mimeType,
 boolean isCDATA,
 boolean isAttribute)

namespaceDeclarations

public void namespaceDeclarations(NamespaceResolver namespaceResolver)

INTERNAL:

Overrides:

namespaceDeclarations in class MarshalRecord<XMLMarshaller>

Parameters:

namespaceResolver - The NamespaceResolver contains the namespace prefix and URI pairings that need to be declared.

nilComplex

public void nilComplex(XPathFragment xPathFragment,
 NamespaceResolver namespaceResolver)

INTERNAL:

Specified by:

nilComplex in interface MarshalRecord<CoreAbstractSession,CoreField,XMLMarshaller,NamespaceResolver>

Overrides:

nilComplex in class MarshalRecord<XMLMarshaller>

nilSimple

public void nilSimple(NamespaceResolver namespaceResolver)

INTERNAL:

Specified by:

nilSimple in interface MarshalRecord<CoreAbstractSession,CoreField,XMLMarshaller,NamespaceResolver>

Overrides:

nilSimple in class MarshalRecord<XMLMarshaller>

emptySimple

public void emptySimple(NamespaceResolver namespaceResolver)

Used when an empty simple value should be written

Specified by:

emptySimple in interface MarshalRecord<CoreAbstractSession,CoreField,XMLMarshaller,NamespaceResolver>

Overrides:

emptySimple in class MarshalRecord<XMLMarshaller>

Since:

EclipseLink 2.4

emptyAttribute

public void emptyAttribute(XPathFragment xPathFragment,
 NamespaceResolver namespaceResolver)

Description copied from class: MarshalRecord

Used when an nil attribute should be written

Specified by:

emptyAttribute in interface MarshalRecord<CoreAbstractSession,CoreField,XMLMarshaller,NamespaceResolver>

Overrides:

emptyAttribute in class MarshalRecord<XMLMarshaller>

emptyComplex

public void emptyComplex(XPathFragment xPathFragment,
 NamespaceResolver namespaceResolver)

Used when an empty complex item should be written

Specified by:

emptyComplex in interface MarshalRecord<CoreAbstractSession,CoreField,XMLMarshaller,NamespaceResolver>

Overrides:

emptyComplex in class MarshalRecord<XMLMarshaller>

Since:

EclipseLink 2.4

marshalWithoutRootElement

public void marshalWithoutRootElement(ObjectBuilder treeObjectBuilder,
 Object object,
 Descriptor descriptor,
 Root root,
 boolean isXMLRoot)

INTERNAL:

Overrides:

marshalWithoutRootElement in class MarshalRecord<XMLMarshaller>

cdata

public void cdata(String value)

INTERNAL:

Specified by:

cdata in interface MarshalRecord<CoreAbstractSession,CoreField,XMLMarshaller,NamespaceResolver>

Specified by:

cdata in class MarshalRecord<XMLMarshaller>

Parameters:

value - This is the value of the text to be wrapped

getNamespaceSeparator

public char getNamespaceSeparator()

INTERNAL: The character used to separate the prefix and uri portions when namespaces are present

Specified by:

getNamespaceSeparator in interface XMLRecord<CoreAbstractSession>

Overrides:

getNamespaceSeparator in class AbstractMarshalRecordImpl<CoreAbstractSession,CoreField,XMLMarshaller,NamespaceResolver>

Since:

2.4

getTextWrapperFragment

public XPathFragment getTextWrapperFragment()

INTERNAL: The optional fragment used to wrap the text() mappings

Specified by:

getTextWrapperFragment in interface MarshalRecord<CoreAbstractSession,CoreField,XMLMarshaller,NamespaceResolver>

Overrides:

getTextWrapperFragment in class MarshalRecord<XMLMarshaller>

Since:

2.4

writeKey

protected void writeKey(XPathFragment xPathFragment)
                 throws IOException

Throws:

IOException

writeValue

protected void writeValue(String value,
 boolean isAttribute)

INTERNAL:

getStringForQName

protected String getStringForQName(QName qName)

Overrides:

getStringForQName in class MarshalRecord<XMLMarshaller>

node

public void node(Node node,
 NamespaceResolver namespaceResolver,
 String uri,
 String name)

Receive notification of a node.

Specified by:

node in class MarshalRecord<XMLMarshaller>

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

uri - replacement root name for the node

name - replacement root namespace for the node namespace URI/prefix of the node

isWrapperAsCollectionName

public boolean isWrapperAsCollectionName()

Specified by:

isWrapperAsCollectionName in interface MarshalRecord<CoreAbstractSession,CoreField,XMLMarshaller,NamespaceResolver>

Overrides:

isWrapperAsCollectionName in class MarshalRecord<XMLMarshaller>

flush

public void flush()

Specified by:

flush in interface MarshalRecord<CoreAbstractSession,CoreField,XMLMarshaller,NamespaceResolver>

Overrides:

flush in class MarshalRecord<XMLMarshaller>