|
EclipseLink 1.1.4, build 'v20100812-r7860' 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
public class WriterRecord
Use this type of MarshalRecord when the marshal target is a Writer and the XML should be not be formatted with carriage returns and indenting.
XMLContext xmlContext = new XMLContext("session-name");
XMLMarshaller xmlMarshaller = xmlContext.createMarshaller();
WriterRecord writerRecord = new WriterRecord();
writerRecord.setWriter(myWriter);
xmlMarshaller.marshal(myObject, writerRecord);
If the marshal(Writer) and setFormattedOutput(false) method is called on XMLMarshaller, then the Writer is automatically wrapped in a WriterRecord.
XMLContext xmlContext = new XMLContext("session-name");
XMLMarshaller xmlMarshaller = xmlContext.createMarshaller();
xmlMarshaller xmlMarshaller.setFormattedOutput(false);
xmlMarshaller.marshal(myObject, myWriter);
XMLMarshaller
,
Serialized FormNested Class Summary | |
---|---|
protected class |
WriterRecord.WriterRecordContentHandler
This class will typically be used in conjunction with an XMLFragmentReader. |
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 | |
---|---|
protected boolean |
isProcessingCData
|
protected boolean |
isStartElementOpen
|
protected java.io.Writer |
writer
|
Fields inherited from class org.eclipse.persistence.oxm.record.XMLRecord |
---|
session |
Fields inherited from class org.eclipse.persistence.internal.sessions.AbstractRecord |
---|
fields, lookupField, noEntry, size, values |
Constructor Summary | |
---|---|
WriterRecord()
|
Method Summary | |
---|---|
void |
attribute(java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String qName,
java.lang.String value)
INTERNAL: |
void |
attribute(org.eclipse.persistence.internal.oxm.XPathFragment xPathFragment,
NamespaceResolver namespaceResolver,
java.lang.String value)
INTERNAL: |
void |
cdata(java.lang.String value)
INTERNAL: |
void |
characters(java.lang.String value)
INTERNAL: |
void |
closeStartElement()
INTERNAL: |
void |
element(java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String qName)
INTERNAL: |
void |
endDocument()
INTERNAL: |
void |
endElement(org.eclipse.persistence.internal.oxm.XPathFragment xPathFragment,
NamespaceResolver namespaceResolver)
INTERNAL: |
java.io.Writer |
getWriter()
Return the Writer that the object will be marshalled to. |
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: |
void |
setWriter(java.io.Writer writer)
Set the Writer that the object will be marshalled to. |
void |
startDocument(java.lang.String encoding,
java.lang.String version)
INTERNAL: |
protected void |
writeValue(java.lang.String value)
INTERNAL: |
Methods inherited from class org.eclipse.persistence.oxm.record.MarshalRecord |
---|
add, addGroupingElement, addPositionalNodes, clear, closeStartGroupingElements, endPrefixMapping, endPrefixMappings, getDocument, getDOM, getLocalName, getNamespaceURI, getPositionalNodes, namespaceDeclarations, openStartGroupingElements, put, removeGroupingElement, resolveNamespacePrefix, startPrefixMapping, startPrefixMappings, transformToXML |
Methods inherited from class org.eclipse.persistence.oxm.record.XMLRecord |
---|
contains, convertToXMLField, get, getCurrentObject, getDocPresPolicy, getIndicatingNoEntry, getLeafElementType, getMarshaller, getNamespaceResolver, getOwningObject, getSession, getUnmarshaller, resolveNamespacePrefix, setCurrentObject, setDocPresPolicy, setLeafElementType, setMarshaller, setNamespaceResolver, setOwningObject, setSession, setUnmarshaller |
Methods inherited from class org.eclipse.persistence.internal.sessions.AbstractRecord |
---|
clone, containsKey, containsKey, containsKey, containsValue, elements, entrySet, get, get, getField, getFields, getIndicatingNoEntry, getValues, getValues, getValues, isEmpty, keys, keySet, mergeFrom, put, put, putAll, remove, remove, remove, replaceAt, resetSize, setFields, 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 |
Field Detail |
---|
protected java.io.Writer writer
protected boolean isStartElementOpen
protected boolean isProcessingCData
Constructor Detail |
---|
public WriterRecord()
Method Detail |
---|
public java.io.Writer getWriter()
public void setWriter(java.io.Writer writer)
writer
- The marshal target.public void startDocument(java.lang.String encoding, java.lang.String version)
startDocument
in class MarshalRecord
encoding
- The XML document will be encoded using this encoding.version
- This specifies the version of XML.public void endDocument()
endDocument
in class MarshalRecord
public void openStartElement(org.eclipse.persistence.internal.oxm.XPathFragment xPathFragment, NamespaceResolver namespaceResolver)
openStartElement
in class MarshalRecord
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).public void element(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName)
element
in class MarshalRecord
namespaceURI
- The namespace URI, if the element is not namespace
qualified the value of this parameter wil be null.localName
- The local name of the element.public void attribute(org.eclipse.persistence.internal.oxm.XPathFragment xPathFragment, NamespaceResolver namespaceResolver, java.lang.String value)
attribute
in class MarshalRecord
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).value
- This is the complete value for the attribute.public void attribute(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName, java.lang.String value)
attribute
in class MarshalRecord
namespaceURI
- The namespace URI, if the attribute is not namespace
qualified the value of this parameter wil be null.localName
- The local name of the attribute.qName
- The qualified name of the attribute.value
- This is the complete value for the attribute.public void closeStartElement()
closeStartElement
in class MarshalRecord
public void endElement(org.eclipse.persistence.internal.oxm.XPathFragment xPathFragment, NamespaceResolver namespaceResolver)
endElement
in class MarshalRecord
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).public void characters(java.lang.String value)
characters
in class MarshalRecord
value
- This is the entire value of the text node.public void cdata(java.lang.String value)
cdata
in class MarshalRecord
value
- This is the value of the text to be wrappedprotected void writeValue(java.lang.String value)
public void node(org.w3c.dom.Node node, NamespaceResolver namespaceResolver)
node
in class MarshalRecord
node
- The Node to be added to the documentnamespaceResolver
- The NamespaceResolver can be used to resolve the
namespace URI/prefix of the node
|
EclipseLink 1.1.4, build 'v20100812-r7860' API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |