Module org.eclipse.persistence.core

Package org.eclipse.persistence.oxm.record

Class WriterRecord

java.lang.Object

org.eclipse.persistence.internal.core.sessions.CoreAbstractRecord

org.eclipse.persistence.internal.oxm.record.AbstractMarshalRecordImpl<CoreAbstractSession,CoreField,MARSHALLER,NamespaceResolver>

org.eclipse.persistence.oxm.record.MarshalRecord<XMLMarshaller>

org.eclipse.persistence.oxm.record.WriterRecord

All Implemented Interfaces:

AbstractMarshalRecord<CoreAbstractSession,CoreField,XMLMarshaller,NamespaceResolver>, MarshalRecord<CoreAbstractSession,CoreField,XMLMarshaller,NamespaceResolver>, XMLRecord<CoreAbstractSession>

Direct Known Subclasses:

FormattedWriterRecord

public class WriterRecord
extends MarshalRecord<XMLMarshaller>

Use this type of MarshalRecord when the marshal target is a Writer and the XML should not be formatted with carriage returns or 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);


See Also:

XMLMarshaller

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	WriterRecord.WriterRecordContentHandler	This class will typically be used in conjunction with an XMLFragmentReader.

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

Modifier and Type	Field	Description
protected StringBuilder	builder
protected CharsetEncoder	encoder
protected boolean	isProcessingCData
protected boolean	isStartElementOpen

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

Constructors

Constructor	Description
WriterRecord()

Method Summary

Modifier and Type	Method	Description
void	attribute(String namespaceURI, String localName, String qName, String value)	INTERNAL:
void	attribute(XPathFragment xPathFragment, NamespaceResolver namespaceResolver, String value)	INTERNAL:
void	cdata(String value)	INTERNAL:
void	characters(String value)	INTERNAL:
void	closeStartElement()	INTERNAL:
void	element(XPathFragment frag)	INTERNAL:
void	endDocument()	INTERNAL:
void	endElement(XPathFragment xPathFragment, NamespaceResolver namespaceResolver)	INTERNAL:
void	flush()
Writer	getWriter()	Return the Writer that the object will be marshalled to.
void	node(Node node, NamespaceResolver namespaceResolver, String newNamespace, String newName)	Receive notification of a node.
void	openStartElement(XPathFragment xPathFragment, NamespaceResolver namespaceResolver)	INTERNAL:
void	setMarshaller(XMLMarshaller marshaller)
void	setWriter(Writer writer)	Set the Writer that the object will be marshalled to.
void	startDocument(String encoding, String version)	INTERNAL:
void	startPrefixMappings(NamespaceResolver namespaceResolver)	INTERNAL: override so we don't iterate over namespaces when startPrefixMapping doesn't do anything
void	writeHeader()	INTERNAL
protected void	writeValue(String value)	INTERNAL:
protected void	writeValue(String value, boolean isAttribute, StringBuilder writer)	INTERNAL:

Methods inherited from class org.eclipse.persistence.oxm.record.MarshalRecord

add, addGroupingElement, addPositionalNodes, afterContainmentMarshal, attribute, beforeContainmentMarshal, characters, clear, closeStartGroupingElements, defaultNamespaceDeclaration, emptyAttribute, emptyCollection, emptyComplex, emptySimple, endCollection, endPrefixMapping, endPrefixMappings, forceValueWrapper, getCurrentAttributeGroup, getCycleDetectionStack, getDocument, getDOM, getGroupingElements, getLocalName, getNameForFragment, getNamespaceURI, getPositionalNodes, getPrefixBytes, getPrefixForFragment, getStringForQName, getTextWrapperFragment, getValueToWrite, isWrapperAsCollectionName, marshalWithoutRootElement, namespaceDeclaration, namespaceDeclarations, nilComplex, nilSimple, node, openStartGroupingElements, popAttributeGroup, predicateAttribute, processNamespaceResolverForXSIPrefix, pushAttributeGroup, put, removeGroupingElement, setGroupingElement, setSession, startCollection, startPrefixMapping, transformToXML

Methods inherited from class org.eclipse.persistence.internal.oxm.record.AbstractMarshalRecordImpl

addExtraNamespacesToNamespaceResolver, addXsiTypeAndClassIndicatorIfRequired, addXsiTypeAndClassIndicatorIfRequired, attributeWithoutQName, getConversionManager, getLeafElementType, getMarshaller, getNamespaceResolver, getNamespaceSeparator, getOwningObject, getSession, hasCustomNamespaceMapper, hasEqualNamespaceResolvers, isNamespaceAware, isXOPPackage, removeExtraNamespacesFromNamespaceResolver, resolveNamespacePrefix, setCustomNamespaceMapper, setEqualNamespaceResolvers, setLeafElementType, setLeafElementType, 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, isNamespaceAware, resolveNamespacePrefix, setCustomNamespaceMapper, setEqualNamespaceResolvers, setLeafElementType, setNamespaceResolver, setOwningObject, setXOPPackage, writeXsiTypeAttribute, writeXsiTypeAttribute

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

attributeWithoutQName, hasCustomNamespaceMapper, isXOPPackage, removeExtraNamespacesFromNamespaceResolver, setLeafElementType

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

getConversionManager, getNamespaceSeparator, getSession

Field Detail

builder

protected StringBuilder builder

isStartElementOpen

protected boolean isStartElementOpen

isProcessingCData

protected boolean isProcessingCData

encoder

protected CharsetEncoder encoder

Constructor Detail

WriterRecord

public WriterRecord()

Method Detail

getWriter

public Writer getWriter()

Return the Writer that the object will be marshalled to.

Returns:

The marshal target.

setWriter

public void setWriter(Writer writer)

Set the Writer that the object will be marshalled to.

Parameters:

writer - The marshal target.

startDocument

public void startDocument(String encoding,
                          String version)

INTERNAL:

Specified by:

startDocument in class MarshalRecord<XMLMarshaller>

Parameters:

encoding - The XML document will be encoded using this encoding.

version - This specifies the version of XML.

writeHeader

public void writeHeader()

INTERNAL

Overrides:

writeHeader in class MarshalRecord<XMLMarshaller>

endDocument

public void endDocument()

INTERNAL:

Specified by:

endDocument in class MarshalRecord<XMLMarshaller>

openStartElement

public void openStartElement(XPathFragment xPathFragment,
                             NamespaceResolver namespaceResolver)

INTERNAL:

Specified by:

openStartElement in interface MarshalRecord<CoreAbstractSession,CoreField,XMLMarshaller,NamespaceResolver>

Overrides:

openStartElement in class MarshalRecord<XMLMarshaller>

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)

INTERNAL:

Specified by:

element in class MarshalRecord<XMLMarshaller>

Parameters:

frag - The XPathFragment of the element

attribute

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

INTERNAL:

Specified by:

attribute in interface MarshalRecord<CoreAbstractSession,CoreField,XMLMarshaller,NamespaceResolver>

Specified by:

attribute in class MarshalRecord<XMLMarshaller>

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.

startPrefixMappings

public void startPrefixMappings(NamespaceResolver namespaceResolver)

INTERNAL: override so we don't iterate over namespaces when startPrefixMapping doesn't do anything

Overrides:

startPrefixMappings in class MarshalRecord<XMLMarshaller>

attribute

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

INTERNAL:

Specified by:

attribute in interface AbstractMarshalRecord<CoreAbstractSession,CoreField,XMLMarshaller,NamespaceResolver>

Specified by:

attribute in interface MarshalRecord<CoreAbstractSession,CoreField,XMLMarshaller,NamespaceResolver>

Specified by:

attribute in class MarshalRecord<XMLMarshaller>

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.

qName - The qualified name of the attribute.

value - This is the complete value for the attribute.

closeStartElement

public void closeStartElement()

INTERNAL:

Specified by:

closeStartElement in interface MarshalRecord<CoreAbstractSession,CoreField,XMLMarshaller,NamespaceResolver>

Specified by:

closeStartElement in class MarshalRecord<XMLMarshaller>

endElement

public void endElement(XPathFragment xPathFragment,
                       NamespaceResolver namespaceResolver)

INTERNAL:

Specified by:

endElement in interface MarshalRecord<CoreAbstractSession,CoreField,XMLMarshaller,NamespaceResolver>

Specified by:

endElement in class MarshalRecord<XMLMarshaller>

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).

characters

public void characters(String value)

INTERNAL:

Specified by:

characters in interface MarshalRecord<CoreAbstractSession,CoreField,XMLMarshaller,NamespaceResolver>

Specified by:

characters in class MarshalRecord<XMLMarshaller>

Parameters:

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

cdata

public void cdata(String value)

INTERNAL:

Specified by:

cdata in interface MarshalRecord<CoreAbstractSession,CoreField,XMLMarshaller,NamespaceResolver>

Specified by:

cdata in class MarshalRecord<XMLMarshaller>

Parameters:

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

writeValue

protected void writeValue(String value)

INTERNAL:

writeValue

protected void writeValue(String value,
                          boolean isAttribute,
                          StringBuilder writer)

INTERNAL:

node

public void node(Node node,
                 NamespaceResolver namespaceResolver,
                 String newNamespace,
                 String newName)

Receive notification of a node.

Specified by:

node in class MarshalRecord<XMLMarshaller>

Parameters:

node - The Node to be added to the document

namespaceResolver - The NamespaceResolver can be used to resolve the namespace URI/prefix of the node

newNamespace - replacement root name for the node

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

setMarshaller

public void setMarshaller(XMLMarshaller marshaller)

Specified by:

setMarshaller in interface AbstractMarshalRecord<CoreAbstractSession,CoreField,XMLMarshaller,NamespaceResolver>

Specified by:

setMarshaller in interface MarshalRecord<CoreAbstractSession,CoreField,XMLMarshaller,NamespaceResolver>

Overrides:

setMarshaller in class AbstractMarshalRecordImpl<CoreAbstractSession,CoreField,XMLMarshaller,NamespaceResolver>

flush

public void flush()

Specified by:

flush in interface MarshalRecord<CoreAbstractSession,CoreField,XMLMarshaller,NamespaceResolver>

Overrides:

flush in class MarshalRecord<XMLMarshaller>