|
EclipseLink 2.4.2, build 'v20130514-5956486' API Reference | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.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
public class FormattedWriterRecord
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);
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.oxm.record.MarshalRecord |
|---|
MarshalRecord.CycleDetectionStack<E> |
| 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 |
|---|
encoder, isProcessingCData, isStartElementOpen, 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.oxm.record.XMLRecord |
|---|
currentObject, equalNamespaceResolvers, hasCustomNamespaceMapper, marshaller, namespaceAware, namespaceResolver, 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,
java.lang.String newNamespace,
java.lang.String newName)
Receive notification of a node. |
void |
openStartElement(org.eclipse.persistence.internal.oxm.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, writeValue, writeValue |
| Methods inherited from class org.eclipse.persistence.internal.sessions.AbstractRecord |
|---|
clone, containsKey, containsKey, containsKey, containsValue, elements, entrySet, get, getField, getFields, getIndicatingNoEntry, getLookupField, getValues, getValues, getValues, hasNullValueInFields, isEmpty, keys, keySet, mergeFrom, 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 |
|---|
public FormattedWriterRecord()
| Method Detail |
|---|
public void endDocument()
endDocument in class WriterRecordpublic void writeHeader()
writeHeader in class WriterRecord
public void openStartElement(org.eclipse.persistence.internal.oxm.XPathFragment xPathFragment,
NamespaceResolver namespaceResolver)
openStartElement in class WriterRecordxPathFragment - 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 WriterRecordfrag - The XPathFragment of the element
public void endElement(org.eclipse.persistence.internal.oxm.XPathFragment xPathFragment,
NamespaceResolver namespaceResolver)
endElement in class WriterRecordxPathFragment - 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 class WriterRecordvalue - This is the entire value of the text node.public void cdata(java.lang.String value)
cdata in class WriterRecordvalue - This is the value of the text to be wrapped
public void node(org.w3c.dom.Node node,
NamespaceResolver namespaceResolver,
java.lang.String newNamespace,
java.lang.String newName)
node in class WriterRecordnode - 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.4.2, build 'v20130514-5956486' API Reference | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||