EclipseLink 2.3.2, build 'v20111125-r10461' API Reference

org.eclipse.persistence.oxm.record
Class FormattedWriterRecord

java.lang.Object
  extended by org.eclipse.persistence.internal.sessions.AbstractRecord
      extended by org.eclipse.persistence.oxm.record.XMLRecord
          extended by org.eclipse.persistence.oxm.record.MarshalRecord
              extended by org.eclipse.persistence.oxm.record.WriterRecord
                  extended by 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.WriterRecord
WriterRecord.WriterRecordContentHandler
 
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.WriterRecord
isProcessingCData, isStartElementOpen, writer
 
Fields inherited from class org.eclipse.persistence.oxm.record.XMLRecord
currentObject, marshaller, NIL, session, unmarshaller
 
Fields inherited from class org.eclipse.persistence.internal.sessions.AbstractRecord
fields, lookupField, noEntry, nullValueInFields, size, values
 
Constructor Summary
FormattedWriterRecord()
           
 
Method Summary
 void cdata(java.lang.String value)
          INTERNAL:
 void characters(java.lang.String value)
          INTERNAL:
 void element(org.eclipse.persistence.internal.oxm.XPathFragment frag)
          INTERNAL:
 void endDocument()
          INTERNAL:
 void endElement(org.eclipse.persistence.internal.oxm.XPathFragment xPathFragment, NamespaceResolver namespaceResolver)
          INTERNAL:
 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:
 
Methods inherited from class org.eclipse.persistence.oxm.record.WriterRecord
attribute, attribute, closeStartElement, endPrefixMappings, getWriter, setWriter, startDocument, startPrefixMappings, writeValue
 
Methods inherited from class org.eclipse.persistence.oxm.record.MarshalRecord
add, addGroupingElement, addPositionalNodes, afterContainmentMarshal, beforeContainmentMarshal, characters, clear, closeStartGroupingElements, endPrefixMapping, getDocument, getDOM, getGroupingElements, getLocalName, getNamespaceURI, getPositionalNodes, getStringForQName, namespaceDeclarations, openStartGroupingElements, predicateAttribute, put, removeGroupingElement, setGroupingElement, startPrefixMapping, transformToXML
 
Methods inherited from class org.eclipse.persistence.oxm.record.XMLRecord
contains, convertToXMLField, convertToXMLField, get, getCurrentObject, getDocPresPolicy, getIndicatingNoEntry, getLeafElementType, getMarshaller, getNamespaceResolver, getOwningObject, getSession, getUnmarshaller, isXOPPackage, resolveNamespacePrefix, setCurrentObject, setDocPresPolicy, setLeafElementType, setMarshaller, setNamespaceResolver, setOwningObject, setSession, setUnmarshaller, setXOPPackage
 
Methods inherited from class org.eclipse.persistence.internal.sessions.AbstractRecord
clone, containsKey, containsKey, containsKey, containsValue, elements, entrySet, get, get, getField, getFields, getIndicatingNoEntry, getLookupField, getValues, getValues, getValues, hasNullValueInFields, isEmpty, keys, keySet, mergeFrom, put, 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

FormattedWriterRecord

public FormattedWriterRecord()
Method Detail

endDocument

public void endDocument()
INTERNAL:

Overrides:
endDocument in class WriterRecord

openStartElement

public void openStartElement(org.eclipse.persistence.internal.oxm.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(org.eclipse.persistence.internal.oxm.XPathFragment frag)
INTERNAL:

Overrides:
element in class WriterRecord
Parameters:
frag - The XPathFragment of the element

endElement

public void endElement(org.eclipse.persistence.internal.oxm.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)
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

EclipseLink 2.3.2, build 'v20111125-r10461' API Reference