Module org.eclipse.persistence.core

Package 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.oxm.record.MarshalRecord

org.eclipse.persistence.oxm.record.XMLStreamWriterRecord

All Implemented Interfaces:

AbstractMarshalRecord, MarshalRecord, 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 Class Summary

Nested classes/interfaces inherited from interface org.eclipse.persistence.internal.oxm.record.MarshalRecord

MarshalRecord.CycleDetectionStack<E>

Nested classes/interfaces inherited from interface org.eclipse.persistence.internal.oxm.record.XMLRecord

XMLRecord.Nil

Field Summary

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, session

Fields inherited from interface org.eclipse.persistence.internal.oxm.record.XMLRecord

DEFAULT_ATTRIBUTE_GROUP, NIL

Constructor Summary

Constructors

Constructor	Description
XMLStreamWriterRecord(XMLStreamWriter xmlStreamWriter)

Method Summary

Modifier and Type	Method	Description
void	attribute(String namespaceURI, String localName, String name, String value)	Receive notification of an attribute.
void	attribute(XPathFragment xPathFragment, NamespaceResolver namespaceResolver, String value)	Receive notification of an attribute.
void	attributeWithoutQName(String namespaceURI, String localName, String prefix, String value)
void	cdata(String value)	Receive notification of character data to be wrapped in a CDATA node.
void	characters(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(String defaultNamespace)	Add the defaultNamespace declaration
void	element(XPathFragment frag)	Receive notification of an element.
void	endDocument()	Recieve notification that a document is being ended.
void	endElement(XPathFragment pathFragment, NamespaceResolver namespaceResolver)	Receive notification that an element is being ended.
XMLStreamWriter	getXMLStreamWriter()
boolean	isNamespaceAware()	Determine if namespaces will be considered during marshal/unmarshal operations.
void	namespaceDeclaration(String prefix, String namespaceURI)	Add the specified namespace declaration
void	namespaceDeclarations(NamespaceResolver namespaceResolver)	INTERNAL: Add the namespace declarations to the XML document.
void	node(Node node, NamespaceResolver resolver, String uri, String name)	Receive notification of a node.
void	openStartElement(XPathFragment xPathFragment, NamespaceResolver namespaceResolver)	Receive notification that an element is being started.
void	setXMLStreamWriter(XMLStreamWriter anXMLStreamWriter)
void	startDocument(String encoding, String version)	Receive notification that a document is being started.
void	startPrefixMapping(String prefix, String namespaceUri)	Receive notification that a namespace has been declared.
void	startPrefixMappings(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, flush, forceValueWrapper, getCurrentAttributeGroup, getCycleDetectionStack, getDocument, getDOM, getGroupingElements, getLocalName, getNameForFragment, getNamespaceURI, getPositionalNodes, getPrefixBytes, 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, getConversionManager, 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.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.MarshalRecord

hasCustomNamespaceMapper, isXOPPackage, removeExtraNamespacesFromNamespaceResolver, setLeafElementType, setMarshaller

Methods inherited from interface org.eclipse.persistence.internal.oxm.record.XMLRecord

getConversionManager, getNamespaceSeparator, getSession

Constructor Details

XMLStreamWriterRecord

public XMLStreamWriterRecord(XMLStreamWriter xmlStreamWriter)

Method Details

getXMLStreamWriter

public XMLStreamWriter getXMLStreamWriter()

setXMLStreamWriter

public void setXMLStreamWriter(XMLStreamWriter anXMLStreamWriter)

attribute

public void attribute(XPathFragment xPathFragment,
 NamespaceResolver namespaceResolver,
 String value)

Description copied from class: MarshalRecord

Receive notification of an attribute.

Specified by:

attribute in interface 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(String defaultNamespace)

Description copied from class: MarshalRecord

Add the defaultNamespace declaration

Overrides:

defaultNamespaceDeclaration in class MarshalRecord

namespaceDeclaration

public void namespaceDeclaration(String prefix,
 String namespaceURI)

Description copied from class: MarshalRecord

Add the specified namespace declaration

Specified by:

namespaceDeclaration in interface AbstractMarshalRecord

Specified by:

namespaceDeclaration in interface MarshalRecord

Overrides:

namespaceDeclaration in class MarshalRecord

attributeWithoutQName

public void attributeWithoutQName(String namespaceURI,
 String localName,
 String prefix,
 String value)

Specified by:

attributeWithoutQName in interface AbstractMarshalRecord

Specified by:

attributeWithoutQName in interface MarshalRecord

Overrides:

attributeWithoutQName in class AbstractMarshalRecordImpl

attribute

public void attribute(String namespaceURI,
 String localName,
 String name,
 String value)

Description copied from class: MarshalRecord

Receive notification of an attribute.

Specified by:

attribute in interface AbstractMarshalRecord

Specified by:

attribute in interface 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(String value)

Description copied from class: MarshalRecord

Receive notification of character data to be wrapped in a CDATA node.

Specified by:

cdata in interface MarshalRecord

Specified by:

cdata in class MarshalRecord

Parameters:

value - This is the value of the text to be wrapped

characters

public void characters(String value)

Description copied from class: MarshalRecord

Receive notification of character data.

Specified by:

characters in interface MarshalRecord

Specified by:

characters in class MarshalRecord

Parameters:

value - This is the entire value of the text node.

isNamespaceAware

public boolean isNamespaceAware()

Description copied from class: AbstractMarshalRecordImpl

Determine if namespaces will be considered during marshal/unmarshal operations.

Specified by:

isNamespaceAware in interface AbstractMarshalRecord

Specified by:

isNamespaceAware in interface XMLRecord

Overrides:

isNamespaceAware in class 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 MarshalRecord

Specified by:

closeStartElement in class MarshalRecord

openStartElement

public void openStartElement(XPathFragment xPathFragment,
 NamespaceResolver namespaceResolver)

Description copied from class: MarshalRecord

Receive notification that an element is being started.

Specified by:

openStartElement in interface 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(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(XPathFragment pathFragment,
 NamespaceResolver namespaceResolver)

Description copied from class: MarshalRecord

Receive notification that an element is being ended.

Specified by:

endElement in interface 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(Node node,
 NamespaceResolver resolver,
 String uri,
 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 document

resolver - The NamespaceResolver can be used to resolve the

uri - replacement root name for the node

name - replacement root namespace for the node namespace URI/prefix of the node

startDocument

public void startDocument(String encoding,
 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(String prefix,
 String namespaceUri)

Description copied from class: MarshalRecord

Receive notification that a namespace has been declared.

Specified by:

startPrefixMapping in interface MarshalRecord

Overrides:

startPrefixMapping in class MarshalRecord

Parameters:

prefix - The namespace prefix.

namespaceUri - The namespace URI.

namespaceDeclarations

public void namespaceDeclarations(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(NamespaceResolver namespaceResolver)

Overrides:

startPrefixMappings in class MarshalRecord