|
EclipseLink 2.5.0, build 'v20130507-3faac2b' API Reference | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.eclipse.persistence.internal.core.sessions.CoreAbstractRecord
org.eclipse.persistence.internal.oxm.record.AbstractMarshalRecordImpl<org.eclipse.persistence.internal.core.sessions.CoreAbstractSession,org.eclipse.persistence.internal.helper.DatabaseField,MARSHALLER,org.eclipse.persistence.internal.oxm.NamespaceResolver>
org.eclipse.persistence.oxm.record.MarshalRecord<org.eclipse.persistence.internal.oxm.XMLMarshaller>
org.eclipse.persistence.oxm.record.OutputStreamRecord
org.eclipse.persistence.oxm.record.FormattedOutputStreamRecord
public class FormattedOutputStreamRecord
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);
XMLMarshaller| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from class org.eclipse.persistence.oxm.record.OutputStreamRecord |
|---|
OutputStreamRecord.OutputStreamRecordContentHandler |
| Nested classes/interfaces inherited from class org.eclipse.persistence.oxm.record.MarshalRecord |
|---|
MarshalRecord.CycleDetectionStack<E> |
| Nested classes/interfaces inherited from interface org.eclipse.persistence.internal.oxm.record.XMLRecord |
|---|
org.eclipse.persistence.internal.oxm.record.XMLRecord.Nil |
| Field Summary |
|---|
| 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.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 | |
|---|---|
FormattedOutputStreamRecord()
|
|
| 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,
org.eclipse.persistence.internal.oxm.NamespaceResolver namespaceResolver)
INTERNAL: |
void |
node(org.w3c.dom.Node node,
org.eclipse.persistence.internal.oxm.NamespaceResolver namespaceResolver,
java.lang.String newNamespace,
java.lang.String newName)
Receive notification of a node. |
void |
openStartElement(org.eclipse.persistence.internal.oxm.XPathFragment xPathFragment,
org.eclipse.persistence.internal.oxm.NamespaceResolver namespaceResolver)
INTERNAL: |
void |
writeHeader()
INTERNAL |
| Methods inherited from class org.eclipse.persistence.oxm.record.OutputStreamRecord |
|---|
attribute, attribute, closeStartElement, flush, getOutputStream, outputStreamWrite, outputStreamWrite, outputStreamWrite, outputStreamWrite, setOutputStream, startDocument, startPrefixMappings, writeValue, writeValue |
| Methods inherited from class org.eclipse.persistence.internal.oxm.record.AbstractMarshalRecordImpl |
|---|
addExtraNamespacesToNamespaceResolver, addXsiTypeAndClassIndicatorIfRequired, addXsiTypeAndClassIndicatorIfRequired, attributeWithoutQName, getLeafElementType, getMarshaller, getNamespaceResolver, getNamespaceSeparator, getOwningObject, getSession, hasCustomNamespaceMapper, hasEqualNamespaceResolvers, isNamespaceAware, isXOPPackage, removeExtraNamespacesFromNamespaceResolver, resolveNamespacePrefix, setCustomNamespaceMapper, setEqualNamespaceResolvers, setLeafElementType, setLeafElementType, setMarshaller, 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.MarshalRecord |
|---|
attributeWithoutQName, hasCustomNamespaceMapper, isXOPPackage, removeExtraNamespacesFromNamespaceResolver, setLeafElementType, setMarshaller |
| 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.XMLRecord |
|---|
getNamespaceSeparator, getSession |
| Constructor Detail |
|---|
public FormattedOutputStreamRecord()
| Method Detail |
|---|
public void endDocument()
endDocument in class OutputStreamRecordpublic void writeHeader()
writeHeader in class OutputStreamRecord
public void openStartElement(org.eclipse.persistence.internal.oxm.XPathFragment xPathFragment,
org.eclipse.persistence.internal.oxm.NamespaceResolver namespaceResolver)
openStartElement in interface org.eclipse.persistence.internal.oxm.record.MarshalRecord<org.eclipse.persistence.internal.core.sessions.CoreAbstractSession,org.eclipse.persistence.internal.helper.DatabaseField,org.eclipse.persistence.internal.oxm.XMLMarshaller,org.eclipse.persistence.internal.oxm.NamespaceResolver>openStartElement in class OutputStreamRecordxPathFragment - 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).public void element(org.eclipse.persistence.internal.oxm.XPathFragment frag)
element in class OutputStreamRecordfrag - The XPathFragment of the element
public void endElement(org.eclipse.persistence.internal.oxm.XPathFragment xPathFragment,
org.eclipse.persistence.internal.oxm.NamespaceResolver namespaceResolver)
endElement in interface org.eclipse.persistence.internal.oxm.record.MarshalRecord<org.eclipse.persistence.internal.core.sessions.CoreAbstractSession,org.eclipse.persistence.internal.helper.DatabaseField,org.eclipse.persistence.internal.oxm.XMLMarshaller,org.eclipse.persistence.internal.oxm.NamespaceResolver>endElement in class OutputStreamRecordxPathFragment - 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).public void characters(java.lang.String value)
characters in interface org.eclipse.persistence.internal.oxm.record.MarshalRecord<org.eclipse.persistence.internal.core.sessions.CoreAbstractSession,org.eclipse.persistence.internal.helper.DatabaseField,org.eclipse.persistence.internal.oxm.XMLMarshaller,org.eclipse.persistence.internal.oxm.NamespaceResolver>characters in class OutputStreamRecordvalue - This is the entire value of the text node.public void cdata(java.lang.String value)
cdata in interface org.eclipse.persistence.internal.oxm.record.MarshalRecord<org.eclipse.persistence.internal.core.sessions.CoreAbstractSession,org.eclipse.persistence.internal.helper.DatabaseField,org.eclipse.persistence.internal.oxm.XMLMarshaller,org.eclipse.persistence.internal.oxm.NamespaceResolver>cdata in class OutputStreamRecordvalue - This is the value of the text to be wrapped
public void node(org.w3c.dom.Node node,
org.eclipse.persistence.internal.oxm.NamespaceResolver namespaceResolver,
java.lang.String newNamespace,
java.lang.String newName)
node in class OutputStreamRecordnode - The Node to be added to the documentnamespaceResolver - The NamespaceResolver can be used to resolve the
namespace URI/prefix of the nodenewName - replacement root namespace for the node
namespace URI/prefix of the node
|
EclipseLink 2.5.0, build 'v20130507-3faac2b' API Reference | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||