org.eclipse.persistence.oxm.record
Class XMLStreamWriterRecord
java.lang.Object
org.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.oxm.record.XMLStreamWriterRecord
- All Implemented Interfaces:
- org.eclipse.persistence.internal.oxm.record.AbstractMarshalRecord, org.eclipse.persistence.internal.oxm.record.MarshalRecord, org.eclipse.persistence.internal.oxm.record.XMLRecord
public class XMLStreamWriterRecord
- extends MarshalRecord
Use this type of MarshalRecord when the marshal target is an XMLStreamWriter
XMLContext xmlContext = new XMLContext("session-name");
XMLMarshaller xmlMarshaller = xmlContext.createMarshaller();
XMLStreamWriterRecord writerRecord = new XMLStreamWriterRecord(xmlStreamWriter);
xmlMarshaller.marshal(myObject, writerRecord);
- See Also:
XMLMarshaller
Nested classes/interfaces inherited from interface org.eclipse.persistence.internal.oxm.record.XMLRecord |
org.eclipse.persistence.internal.oxm.record.XMLRecord.Nil |
Fields inherited from class org.eclipse.persistence.internal.oxm.record.AbstractMarshalRecordImpl |
equalNamespaceResolvers, hasCustomNamespaceMapper, marshaller, namespaceAware, session |
Fields inherited from interface org.eclipse.persistence.internal.oxm.record.XMLRecord |
DEFAULT_ATTRIBUTE_GROUP, NIL |
Method Summary |
void |
attribute(java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String name,
java.lang.String value)
Receive notification of an attribute. |
void |
attribute(org.eclipse.persistence.internal.oxm.XPathFragment xPathFragment,
org.eclipse.persistence.internal.oxm.NamespaceResolver namespaceResolver,
java.lang.String value)
Receive notification of an attribute. |
void |
attributeWithoutQName(java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String prefix,
java.lang.String value)
|
void |
cdata(java.lang.String value)
Receive notification of character data to be wrapped in a CDATA node. |
void |
characters(java.lang.String value)
Receive notification of character data. |
void |
closeStartElement()
Receive notification that all of the attribute events have occurred for
the most recent element that has been started. |
void |
defaultNamespaceDeclaration(java.lang.String defaultNamespace)
Add the defaultNamespace declaration |
void |
element(org.eclipse.persistence.internal.oxm.XPathFragment frag)
Receive notification of an element. |
void |
endDocument()
Recieve notification that a document is being ended. |
void |
endElement(org.eclipse.persistence.internal.oxm.XPathFragment pathFragment,
org.eclipse.persistence.internal.oxm.NamespaceResolver namespaceResolver)
Receive notification that an element is being ended. |
javax.xml.stream.XMLStreamWriter |
getXMLStreamWriter()
|
boolean |
isNamespaceAware()
|
void |
namespaceDeclaration(java.lang.String prefix,
java.lang.String namespaceURI)
Add the specified namespace declaration |
void |
namespaceDeclarations(org.eclipse.persistence.internal.oxm.NamespaceResolver namespaceResolver)
INTERNAL:
Add the namespace declarations to the XML document. |
void |
node(org.w3c.dom.Node node,
org.eclipse.persistence.internal.oxm.NamespaceResolver resolver,
java.lang.String uri,
java.lang.String name)
Receive notification of a node. |
void |
openStartElement(org.eclipse.persistence.internal.oxm.XPathFragment xPathFragment,
org.eclipse.persistence.internal.oxm.NamespaceResolver namespaceResolver)
Receive notification that an element is being started. |
void |
setXMLStreamWriter(javax.xml.stream.XMLStreamWriter anXMLStreamWriter)
|
void |
startDocument(java.lang.String encoding,
java.lang.String version)
Receive notification that a document is being started. |
void |
startPrefixMapping(java.lang.String prefix,
java.lang.String namespaceUri)
Receive notification that a namespace has been declared. |
void |
startPrefixMappings(org.eclipse.persistence.internal.oxm.NamespaceResolver namespaceResolver)
|
Methods inherited from class org.eclipse.persistence.oxm.record.MarshalRecord |
add, addGroupingElement, addPositionalNodes, afterContainmentMarshal, attribute, beforeContainmentMarshal, characters, clear, closeStartGroupingElements, emptyAttribute, emptyCollection, emptyComplex, emptySimple, endCollection, endPrefixMapping, endPrefixMappings, getCurrentAttributeGroup, getCycleDetectionStack, getDocument, getDOM, getGroupingElements, getLocalName, getNameForFragment, getNameForFragmentBytes, getNamespaceURI, getPositionalNodes, getPrefixForFragment, getStringForQName, getTextWrapperFragment, getValueToWrite, isWrapperAsCollectionName, marshalWithoutRootElement, nilComplex, nilSimple, node, openStartGroupingElements, popAttributeGroup, predicateAttribute, processNamespaceResolverForXSIPrefix, pushAttributeGroup, put, removeGroupingElement, setGroupingElement, setSession, startCollection, transformToXML, writeHeader |
Methods inherited from class org.eclipse.persistence.internal.oxm.record.AbstractMarshalRecordImpl |
addExtraNamespacesToNamespaceResolver, addXsiTypeAndClassIndicatorIfRequired, addXsiTypeAndClassIndicatorIfRequired, getLeafElementType, getMarshaller, getNamespaceResolver, getNamespaceSeparator, getOwningObject, getSession, hasCustomNamespaceMapper, hasEqualNamespaceResolvers, 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 |
hasCustomNamespaceMapper, isXOPPackage, removeExtraNamespacesFromNamespaceResolver, setLeafElementType, setMarshaller |
Methods inherited from interface org.eclipse.persistence.internal.oxm.record.AbstractMarshalRecord |
addExtraNamespacesToNamespaceResolver, addXsiTypeAndClassIndicatorIfRequired, addXsiTypeAndClassIndicatorIfRequired, getLeafElementType, getMarshaller, getNamespaceResolver, getOwningObject, hasEqualNamespaceResolvers, resolveNamespacePrefix, setCustomNamespaceMapper, setEqualNamespaceResolvers, setLeafElementType, setNamespaceResolver, setOwningObject, setXOPPackage, writeXsiTypeAttribute, writeXsiTypeAttribute |
Methods inherited from interface org.eclipse.persistence.internal.oxm.record.XMLRecord |
getNamespaceSeparator, getSession |
XMLStreamWriterRecord
public XMLStreamWriterRecord(javax.xml.stream.XMLStreamWriter xmlStreamWriter)
getXMLStreamWriter
public javax.xml.stream.XMLStreamWriter getXMLStreamWriter()
setXMLStreamWriter
public void setXMLStreamWriter(javax.xml.stream.XMLStreamWriter anXMLStreamWriter)
attribute
public void attribute(org.eclipse.persistence.internal.oxm.XPathFragment xPathFragment,
org.eclipse.persistence.internal.oxm.NamespaceResolver namespaceResolver,
java.lang.String value)
- Description copied from class:
MarshalRecord
- Receive notification of an attribute.
- Specified by:
attribute
in interface org.eclipse.persistence.internal.oxm.record.MarshalRecord
- Specified by:
attribute
in class MarshalRecord
- 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).value
- This is the complete value for the attribute.
defaultNamespaceDeclaration
public void defaultNamespaceDeclaration(java.lang.String defaultNamespace)
- Description copied from class:
MarshalRecord
- Add the defaultNamespace declaration
- Overrides:
defaultNamespaceDeclaration
in class MarshalRecord
namespaceDeclaration
public void namespaceDeclaration(java.lang.String prefix,
java.lang.String namespaceURI)
- Description copied from class:
MarshalRecord
- Add the specified namespace declaration
- Specified by:
namespaceDeclaration
in interface org.eclipse.persistence.internal.oxm.record.AbstractMarshalRecord
- Specified by:
namespaceDeclaration
in interface org.eclipse.persistence.internal.oxm.record.MarshalRecord
- Overrides:
namespaceDeclaration
in class MarshalRecord
attributeWithoutQName
public void attributeWithoutQName(java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String prefix,
java.lang.String value)
- Specified by:
attributeWithoutQName
in interface org.eclipse.persistence.internal.oxm.record.AbstractMarshalRecord
- Specified by:
attributeWithoutQName
in interface org.eclipse.persistence.internal.oxm.record.MarshalRecord
- Overrides:
attributeWithoutQName
in class org.eclipse.persistence.internal.oxm.record.AbstractMarshalRecordImpl
attribute
public void attribute(java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String name,
java.lang.String value)
- Description copied from class:
MarshalRecord
- Receive notification of an attribute.
- Specified by:
attribute
in interface org.eclipse.persistence.internal.oxm.record.AbstractMarshalRecord
- Specified by:
attribute
in interface org.eclipse.persistence.internal.oxm.record.MarshalRecord
- Specified by:
attribute
in class MarshalRecord
- Parameters:
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.name
- The qualified name of the attribute.value
- This is the complete value for the attribute.
cdata
public void cdata(java.lang.String value)
- Description copied from class:
MarshalRecord
- Receive notification of character data to be wrapped in a CDATA node.
- Specified by:
cdata
in interface org.eclipse.persistence.internal.oxm.record.MarshalRecord
- Specified by:
cdata
in class MarshalRecord
- Parameters:
value
- This is the value of the text to be wrapped
characters
public void characters(java.lang.String value)
- Description copied from class:
MarshalRecord
- Receive notification of character data.
- Specified by:
characters
in interface org.eclipse.persistence.internal.oxm.record.MarshalRecord
- Specified by:
characters
in class MarshalRecord
- Parameters:
value
- This is the entire value of the text node.
isNamespaceAware
public boolean isNamespaceAware()
- Specified by:
isNamespaceAware
in interface org.eclipse.persistence.internal.oxm.record.AbstractMarshalRecord
- Specified by:
isNamespaceAware
in interface org.eclipse.persistence.internal.oxm.record.XMLRecord
- Overrides:
isNamespaceAware
in class org.eclipse.persistence.internal.oxm.record.AbstractMarshalRecordImpl
closeStartElement
public void closeStartElement()
- Description copied from class:
MarshalRecord
- Receive notification that all of the attribute events have occurred for
the most recent element that has been started.
- Specified by:
closeStartElement
in interface org.eclipse.persistence.internal.oxm.record.MarshalRecord
- Specified by:
closeStartElement
in class MarshalRecord
openStartElement
public void openStartElement(org.eclipse.persistence.internal.oxm.XPathFragment xPathFragment,
org.eclipse.persistence.internal.oxm.NamespaceResolver namespaceResolver)
- Description copied from class:
MarshalRecord
- Receive notification that an element is being started.
- Specified by:
openStartElement
in interface org.eclipse.persistence.internal.oxm.record.MarshalRecord
- Overrides:
openStartElement
in class MarshalRecord
- 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)
- Description copied from class:
MarshalRecord
- Receive notification of an element.
- Specified by:
element
in class MarshalRecord
- Parameters:
frag
- The XPathFragment of the element
endDocument
public void endDocument()
- Description copied from class:
MarshalRecord
- Recieve notification that a document is being ended.
- Specified by:
endDocument
in class MarshalRecord
endElement
public void endElement(org.eclipse.persistence.internal.oxm.XPathFragment pathFragment,
org.eclipse.persistence.internal.oxm.NamespaceResolver namespaceResolver)
- Description copied from class:
MarshalRecord
- Receive notification that an element is being ended.
- Specified by:
endElement
in interface org.eclipse.persistence.internal.oxm.record.MarshalRecord
- Specified by:
endElement
in class MarshalRecord
- Parameters:
pathFragment
- 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).
node
public void node(org.w3c.dom.Node node,
org.eclipse.persistence.internal.oxm.NamespaceResolver resolver,
java.lang.String uri,
java.lang.String name)
- Description copied from class:
MarshalRecord
- Receive notification of a node.
- Specified by:
node
in class MarshalRecord
- Parameters:
node
- The Node to be added to the documentname
- replacement root namespace for the node
namespace URI/prefix of the node
startDocument
public void startDocument(java.lang.String encoding,
java.lang.String version)
- Description copied from class:
MarshalRecord
- Receive notification that a document is being started.
- Specified by:
startDocument
in class MarshalRecord
- Parameters:
encoding
- The XML document will be encoded using this encoding.version
- This specifies the version of XML.
startPrefixMapping
public void startPrefixMapping(java.lang.String prefix,
java.lang.String namespaceUri)
- Description copied from class:
MarshalRecord
- Receive notification that a namespace has been declared.
- Specified by:
startPrefixMapping
in interface org.eclipse.persistence.internal.oxm.record.MarshalRecord
- Overrides:
startPrefixMapping
in class MarshalRecord
- Parameters:
prefix
- The namespace prefix.namespaceUri
- The namespace URI.
namespaceDeclarations
public void namespaceDeclarations(org.eclipse.persistence.internal.oxm.NamespaceResolver namespaceResolver)
- Description copied from class:
MarshalRecord
- INTERNAL:
Add the namespace declarations to the XML document.
- Overrides:
namespaceDeclarations
in class MarshalRecord
- Parameters:
namespaceResolver
- The NamespaceResolver contains the namespace
prefix and URI pairings that need to be declared.
startPrefixMappings
public void startPrefixMappings(org.eclipse.persistence.internal.oxm.NamespaceResolver namespaceResolver)
- Overrides:
startPrefixMappings
in class MarshalRecord