org.eclipse.persistence.oxm.record

Class FormattedWriterRecord

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

org.eclipse.persistence.oxm.record.FormattedWriterRecord

All Implemented Interfaces:

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

public class FormattedWriterRecord
extends WriterRecord

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

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


If the marshal(Writer) and setFormattedOutput(true) method is called on XMLMarshaller, then the Writer is automatically wrapped in a FormattedWriterRecord.

XMLContext xmlContext = new XMLContext("session-name");
XMLMarshaller xmlMarshaller = xmlContext.createMarshaller();
xmlMarshaller 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
FormattedWriterRecord()

Method Summary

Modifier and Type	Method and Description
void	cdata(java.lang.String value) INTERNAL:
void	characters(java.lang.String value) INTERNAL:
void	element(XPathFragment frag) INTERNAL:
void	endDocument() INTERNAL:
void	endElement(XPathFragment xPathFragment, NamespaceResolver namespaceResolver) INTERNAL:
void	node(org.w3c.dom.Node node, NamespaceResolver namespaceResolver, java.lang.String newNamespace, java.lang.String newName) Receive notification of a node.
void	openStartElement(XPathFragment xPathFragment, NamespaceResolver namespaceResolver) INTERNAL:
void	writeHeader() INTERNAL

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

attribute, attribute, closeStartElement, getWriter, setMarshaller, setWriter, startDocument, startPrefixMappings

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

add, addGroupingElement, afterContainmentMarshal, attribute, beforeContainmentMarshal, characters, clear, closeStartGroupingElements, defaultNamespaceDeclaration, emptyAttribute, emptyCollection, emptyComplex, emptySimple, endCollection, endPrefixMapping, endPrefixMappings, getCycleDetectionStack, getDocument, getDOM, getGroupingElements, getLocalName, getNamespaceURI, getPositionalNodes, getTextWrapperFragment, getValueToWrite, isWrapperAsCollectionName, marshalWithoutRootElement, namespaceDeclaration, namespaceDeclarations, nilComplex, nilSimple, node, openStartGroupingElements, predicateAttribute, put, removeGroupingElement, setGroupingElement, setSession, startCollection, startPrefixMapping, transformToXML

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

attributeWithoutQName, contains, get, get, getCurrentObject, getDocPresPolicy, getIndicatingNoEntry, getLeafElementType, getMarshaller, getNamespaceResolver, getNamespaceSeparator, 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

FormattedWriterRecord

public FormattedWriterRecord()

Method Detail

endDocument

public void endDocument()

INTERNAL:

Overrides:

endDocument in class WriterRecord

writeHeader

public void writeHeader()

INTERNAL

Overrides:

writeHeader in class WriterRecord

openStartElement

public void openStartElement(XPathFragment xPathFragment,
                             NamespaceResolver namespaceResolver)

INTERNAL:

Overrides:

openStartElement in class WriterRecord

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 WriterRecord

Parameters:

frag - The XPathFragment of the element

endElement

public void endElement(XPathFragment xPathFragment,
                       NamespaceResolver namespaceResolver)

INTERNAL:

Overrides:

endElement in class WriterRecord

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

characters

public void characters(java.lang.String value)

INTERNAL:

Overrides:

characters in class WriterRecord

Parameters:

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

cdata

public void cdata(java.lang.String value)

INTERNAL:

Overrides:

cdata in class WriterRecord

Parameters:

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

node

public void node(org.w3c.dom.Node node,
                 NamespaceResolver namespaceResolver,
                 java.lang.String newNamespace,
                 java.lang.String newName)

Receive notification of a node.

Overrides:

node in class WriterRecord

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

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