Skip navigation links
org.eclipse.persistence.oxm.record
Class FormattedOutputStreamRecord
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.OutputStreamRecord
org.eclipse.persistence.oxm.record.FormattedOutputStreamRecord
- All Implemented Interfaces:
- java.io.Serializable, java.lang.Cloneable, java.util.Map, Record
-
public class FormattedOutputStreamRecord
- extends OutputStreamRecord
Use this type of MarshalRecord when the marshal target is an OutputStream and the XML should be formatted with carriage returns and indenting. This type is only used if the encoding of the OutputStream is UTF-8
XMLContext xmlContext = new XMLContext("session-name");
XMLMarshaller xmlMarshaller = xmlContext.createMarshaller();
FormattedOutputStreamRecord record = new FormattedOutputStreamRecord();
record.setOutputStream(myOutputStream);
xmlMarshaller.marshal(myObject, record);
If the marshal(OutputStream) and setFormattedOutput(true) method is called on XMLMarshaller and the encoding is UTF-8, then the OutputStream is automatically wrapped in a FormattedOutputStreamRecord.
XMLContext xmlContext = new XMLContext("session-name");
XMLMarshaller xmlMarshaller = xmlContext.createMarshaller();
xmlMarshaller xmlMarshaller.setFormattedOutput(true);
xmlMarshaller.marshal(myObject, myOutputStream);
- See Also:
XMLMarshaller
, Serialized Form
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> |
Fields inherited from class org.eclipse.persistence.oxm.record.OutputStreamRecord |
AMP, CLOSE_ATTRIBUTE_VALUE, CLOSE_CDATA, CLOSE_COMMENT, CLOSE_ELEMENT, CLOSE_PI, CR, ENCODING, isProcessingCData, isStartElementOpen, LT, OPEN_CDATA, OPEN_COMMENT, OPEN_ENCODING_ATTRIBUTE, OPEN_START_ELEMENT, OPEN_XML_PI_AND_VERSION_ATTRIBUTE, outputStream, QUOT, SPACE |
Fields inherited from class org.eclipse.persistence.internal.sessions.AbstractRecord |
fields, lookupField, noEntry, nullValueInFields, size, values |
Methods inherited from class org.eclipse.persistence.oxm.record.OutputStreamRecord |
attribute, attribute, closeStartElement, flush, getOutputStream, outputStreamWrite, outputStreamWrite, setOutputStream, startDocument, startPrefixMappings, writeValue |
Methods inherited from class org.eclipse.persistence.oxm.record.MarshalRecord |
add, addGroupingElement, addPositionalNodes, afterContainmentMarshal, beforeContainmentMarshal, clear, closeStartGroupingElements, endPrefixMapping, endPrefixMappings, getDocument, getDOM, getGroupingElements, getLocalName, getNamespaceURI, getPositionalNodes, 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 |
numberOfTabs
private int numberOfTabs
complexType
private boolean complexType
isLastEventText
private boolean isLastEventText
FormattedOutputStreamRecord
public FormattedOutputStreamRecord()
endDocument
public void endDocument()
- INTERNAL:
-
- Overrides:
endDocument
in class OutputStreamRecord
openStartElement
public void openStartElement(org.eclipse.persistence.internal.oxm.XPathFragment xPathFragment,
NamespaceResolver namespaceResolver)
- INTERNAL:
-
- Overrides:
openStartElement
in class OutputStreamRecord
-
- 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 OutputStreamRecord
-
- 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 OutputStreamRecord
-
- 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 OutputStreamRecord
-
- Parameters:
value
- This is the entire value of the text node.
cdata
public void cdata(java.lang.String value)
- INTERNAL:
-
- Overrides:
cdata
in class OutputStreamRecord
-
- 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 OutputStreamRecord
-
- 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
outputStreamWriteTab
private void outputStreamWriteTab()
Skip navigation links