Package org.eclipse.persistence.internal.oxm

Class XMLMarshaller<ABSTRACT_SESSION extends CoreAbstractSession,CHARACTER_ESCAPE_HANDLER extends CharacterEscapeHandler,CONTEXT extends Context<ABSTRACT_SESSION,DESCRIPTOR,?,?,?,SESSION,?>,DESCRIPTOR extends Descriptor<?,?,?,?,?,?,?,?,?,?>,MARSHALLER_LISTENER extends Marshaller.Listener,MEDIA_TYPE extends MediaType,NAMESPACE_PREFIX_MAPPER extends NamespacePrefixMapper,OBJECT_BUILDER extends ObjectBuilder<?,ABSTRACT_SESSION,?,XMLMarshaller>,SESSION extends CoreSession>

java.lang.Object
- org.eclipse.persistence.internal.oxm.Marshaller<CHARACTER_ESCAPE_HANDLER,CONTEXT,MARSHALLER_LISTENER,MEDIA_TYPE,NAMESPACE_PREFIX_MAPPER>
- - org.eclipse.persistence.internal.oxm.XMLMarshaller<ABSTRACT_SESSION,CHARACTER_ESCAPE_HANDLER,CONTEXT,DESCRIPTOR,MARSHALLER_LISTENER,MEDIA_TYPE,NAMESPACE_PREFIX_MAPPER,OBJECT_BUILDER,SESSION>

Direct Known Subclasses:: XMLMarshaller

public abstract class XMLMarshaller<ABSTRACT_SESSION extends CoreAbstractSession,CHARACTER_ESCAPE_HANDLER extends CharacterEscapeHandler,CONTEXT extends Context<ABSTRACT_SESSION,DESCRIPTOR,?,?,?,SESSION,?>,DESCRIPTOR extends Descriptor<?,?,?,?,?,?,?,?,?,?>,MARSHALLER_LISTENER extends Marshaller.Listener,MEDIA_TYPE extends MediaType,NAMESPACE_PREFIX_MAPPER extends NamespacePrefixMapper,OBJECT_BUILDER extends ObjectBuilder<?,ABSTRACT_SESSION,?,XMLMarshaller>,SESSION extends CoreSession>
extends Marshaller<CHARACTER_ESCAPE_HANDLER,CONTEXT,MARSHALLER_LISTENER,MEDIA_TYPE,NAMESPACE_PREFIX_MAPPER>

Nested Class Summary
- Nested classes/interfaces inherited from class org.eclipse.persistence.internal.oxm.Marshaller
  Marshaller.Listener

Field Summary

Fields
Modifier and Type	Field	Description
`protected XMLAttachmentMarshaller`	`attachmentMarshaller`
`protected static java.lang.String`	`DEFAULT_XML_VERSION`
`protected static java.lang.Class`	`domToEventWriterClass`
`protected static java.lang.Class`	`domToStreamWriterClass`
`protected MEDIA_TYPE`	`mediaType`
`protected static java.lang.Class`	`staxResultClass`
`protected static java.lang.reflect.Method`	`staxResultGetEventWriterMethod`
`protected static java.lang.reflect.Method`	`staxResultGetStreamWriterMethod`
`protected XMLTransformer`	`transformer`
`protected static java.lang.reflect.Method`	`writeToEventWriterMethod`
`protected static java.lang.reflect.Method`	`writeToStreamMethod`

Fields inherited from class org.eclipse.persistence.internal.oxm.Marshaller
context, mapper, marshalProperties

Constructor Summary

Constructors
Modifier Constructor Description

XMLMarshaller(CONTEXT context)

protected XMLMarshaller(XMLMarshaller xmlMarshaller)
Copy constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`addDescriptorNamespacesToXMLRecord(DESCRIPTOR xmlDescriptor, AbstractMarshalRecord record)`
`protected void`	`copyNamespaces(NamespaceResolver source, NamespaceResolver target)`
`XMLAttachmentMarshaller`	`getAttachmentMarshaller()`
`java.lang.String`	`getAttributePrefix()`	Value that will be used to prefix attributes.
`protected DESCRIPTOR`	`getDescriptor(java.lang.Class clazz, ABSTRACT_SESSION session)`	INTERNAL: Return the descriptor for the root object.
`DESCRIPTOR`	`getDescriptor(java.lang.Object object)`	INTERNAL: Return the descriptor for the root object.
`protected DESCRIPTOR`	`getDescriptor(java.lang.Object object, boolean isXMLRoot)`
`protected DESCRIPTOR`	`getDescriptor(java.lang.Object object, ABSTRACT_SESSION session)`	INTERNAL: Return the descriptor for the root object.
`protected DESCRIPTOR`	`getDescriptor(Root object)`
`protected DESCRIPTOR`	`getDescriptor(Root object, ABSTRACT_SESSION session)`
`java.lang.Object`	`getMarshalAttributeGroup()`
`char`	`getNamespaceSeparator()`	Get the namespace separator used during marshal operations.
`protected org.w3c.dom.Node`	`getNode(java.lang.Object object, org.w3c.dom.Node parentNode, ABSTRACT_SESSION session, DESCRIPTOR descriptor, boolean isRoot)`
`java.lang.String`	`getNoNamespaceSchemaLocation()`	Get the no namespace schema location set on this XMLMarshaller
`javax.xml.validation.Schema`	`getSchema()`
`java.lang.String`	`getSchemaLocation()`	Get the schema location set on this XMLMarshaller
`XMLTransformer`	`getTransformer()`	INTERNAL
`java.lang.String`	`getValueWrapper()`	Name of the property to marshal/unmarshal as a wrapper on the text() mappings Ignored marshalling XML.
`java.lang.String`	`getXmlHeader()`	Get this Marshaller's XML Header.
`boolean`	`isApplicationJSON()`	INTERNAL
`boolean`	`isApplicationXML()`	INTERNAL
`boolean`	`isFragment()`	PUBLIC: Returns if this should marshal to a fragment.
`boolean`	`isIncludeRoot()`	Determine if the @XMLRootElement should be marshalled when present.
`java.lang.Boolean`	`isLogPayload()`
`boolean`	`isMarshalEmptyCollections()`	Name of the property to determine if empty collections should be marshalled as [] Ignored marshalling XML.
`boolean`	`isReduceAnyArrays()`	Property to determine if size 1 any collections should be treated as collections Ignored marshalling XML.
`protected boolean`	`isSimpleXMLRoot(Root xmlRoot)`
`boolean`	`isWrapperAsCollectionName()`
`void`	`marshal(java.lang.Object object, java.io.OutputStream outputStream)`	PUBLIC: Convert the given object to XML and update the given outputStream with that XML Document
`void`	`marshal(java.lang.Object object, java.io.Writer writer)`	PUBLIC: Convert the given object to XML and update the given writer with that XML Document
`void`	`marshal(java.lang.Object object, javax.xml.transform.Result result)`	PUBLIC: Convert the given object to XML and update the given result with that XML Document
`void`	`marshal(java.lang.Object object, MarshalRecord marshalRecord)`	Convert the given object to XML and update the given marshal record with that XML Document.
`protected void`	`marshal(java.lang.Object object, MarshalRecord marshalRecord, ABSTRACT_SESSION session, DESCRIPTOR descriptor, boolean isXMLRoot)`	Convert the given object to XML and update the given marshal record with that XML Document.
`void`	`marshal(java.lang.Object object, org.w3c.dom.Node node)`	PUBLIC:
`void`	`marshal(java.lang.Object object, org.xml.sax.ContentHandler contentHandler)`	PUBLIC: Convert the given object to XML and update the given contentHandler with that XML Document
`void`	`marshal(java.lang.Object object, org.xml.sax.ContentHandler contentHandler, org.xml.sax.ext.LexicalHandler lexicalHandler)`	PUBLIC: Convert the given object to XML and update the given contentHandler with that XML Document
`org.w3c.dom.Document`	`objectToXML(java.lang.Object object)`	PUBLIC: Convert the given object to an XML Document
`protected org.w3c.dom.Document`	`objectToXML(java.lang.Object object, DESCRIPTOR descriptor, boolean isXMLRoot)`	INTERNAL: Convert the given object to an XML Document
`protected org.w3c.dom.Node`	`objectToXMLNode(java.lang.Object object, ABSTRACT_SESSION session, DESCRIPTOR descriptor, boolean isXMLRoot)`	INTERNAL: Like ObjectToXML but is may also return a document fragment instead of a document in the case of a non-root object.
`protected org.w3c.dom.Node`	`objectToXMLNode(java.lang.Object object, org.w3c.dom.Node rootNode, ABSTRACT_SESSION session, DESCRIPTOR descriptor, boolean isXMLRoot)`
`void`	`setAttachmentMarshaller(XMLAttachmentMarshaller atm)`
`void`	`setAttributePrefix(java.lang.String attributePrefix)`	Value that will be used to prefix attributes.
`void`	`setEncoding(java.lang.String newEncoding)`	Set the encoding on this XMLMarshaller If the encoding is not set the default UTF-8 will be used
`void`	`setFormattedOutput(boolean shouldFormat)`	Set if this XMLMarshaller should format the XML By default this is set to true and the XML marshalled will be formatted.
`void`	`setFragment(boolean fragment)`	PUBLIC: Set if this should marshal to a fragment.
`void`	`setIncludeRoot(boolean includeRoot)`	Determine if the @XMLRootElement should be marshalled when present.
`void`	`setLogPayload(java.lang.Boolean logPayload)`
`void`	`setMarshalAttributeGroup(java.lang.Object group)`
`void`	`setMarshalEmptyCollections(java.lang.Boolean marshalEmptyCollections)`	Name of the property to determine if empty collections should be marshalled as [] Ignored marshalling XML.
`void`	`setMediaType(MEDIA_TYPE mediaType)`	Set the MediaType for this xmlMarshaller.
`void`	`setNamespaceSeparator(char namespaceSeparator)`	Set the namespace separator used during marshal operations.
`void`	`setNoNamespaceSchemaLocation(java.lang.String newNoNamespaceSchemaLocation)`	Set the no namespace schema location on this XMLMarshaller
`void`	`setReduceAnyArrays(boolean reduceAnyArrays)`	Property to determine if size 1 any collections should be treated as collections Ignored marshalling XML.
`void`	`setSchema(javax.xml.validation.Schema schema)`
`void`	`setSchemaLocation(java.lang.String newSchemaLocation)`	Set the schema location on this XMLMarshaller
`void`	`setValueWrapper(java.lang.String valueWrapper)`	Name of the property to marshal/unmarshal as a wrapper on the text() mappings Ignored marshalling XML.
`void`	`setWrapperAsCollectionName(boolean wrapperAsCollectionName)`
`void`	`setXmlHeader(java.lang.String xmlHeader)`	Set this Marshaller's XML Header.

Methods inherited from class org.eclipse.persistence.internal.oxm.Marshaller
getCharacterEscapeHandler, getContext, getEncoding, getErrorHandler, getIndentString, getJsonTypeConfiguration, getMarshalListener, getNamespacePrefixMapper, getProperty, isEqualUsingIdenity, isFormattedOutput, setCharacterEscapeHandler, setEqualUsingIdenity, setErrorHandler, setIndentString, setMarshalListener, setNamespacePrefixMapper

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_XML_VERSION
```
protected static final java.lang.String DEFAULT_XML_VERSION
```
    See Also:
    
    Constant Field Values
  - staxResultClass
```
protected static java.lang.Class staxResultClass
```
  - staxResultGetStreamWriterMethod
```
protected static java.lang.reflect.Method staxResultGetStreamWriterMethod
```
  - staxResultGetEventWriterMethod
```
protected static java.lang.reflect.Method staxResultGetEventWriterMethod
```
  - writeToStreamMethod
```
protected static java.lang.reflect.Method writeToStreamMethod
```
  - writeToEventWriterMethod
```
protected static java.lang.reflect.Method writeToEventWriterMethod
```
  - domToStreamWriterClass
```
protected static java.lang.Class domToStreamWriterClass
```
  - domToEventWriterClass
```
protected static java.lang.Class domToEventWriterClass
```
  - attachmentMarshaller
```
protected XMLAttachmentMarshaller attachmentMarshaller
```
  - mediaType
```
protected MEDIA_TYPE extends MediaType mediaType
```
  - transformer
```
protected XMLTransformer transformer
```
- Constructor Detail
  - XMLMarshaller
```
public XMLMarshaller(CONTEXT context)
```
  - XMLMarshaller
```
protected XMLMarshaller(XMLMarshaller xmlMarshaller)
```
    Copy constructor
- Method Detail
  - addDescriptorNamespacesToXMLRecord
```
protected void addDescriptorNamespacesToXMLRecord(DESCRIPTOR xmlDescriptor,
                                                  AbstractMarshalRecord record)
```
  - copyNamespaces
```
protected void copyNamespaces(NamespaceResolver source,
                              NamespaceResolver target)
```
  - getAttachmentMarshaller
```
public XMLAttachmentMarshaller getAttachmentMarshaller()
```
    Specified by:
    
    getAttachmentMarshaller in class Marshaller<CHARACTER_ESCAPE_HANDLER extends CharacterEscapeHandler,CONTEXT extends Context<ABSTRACT_SESSION,DESCRIPTOR,?,?,?,SESSION,?>,MARSHALLER_LISTENER extends Marshaller.Listener,MEDIA_TYPE extends MediaType,NAMESPACE_PREFIX_MAPPER extends NamespacePrefixMapper>
  - getAttributePrefix
```
public java.lang.String getAttributePrefix()
```
    Value that will be used to prefix attributes. Ignored marshalling XML.
    
    Since:
    
    2.4
  - getDescriptor
```
protected DESCRIPTOR getDescriptor(java.lang.Class clazz,
                                   ABSTRACT_SESSION session)
                            throws XMLMarshalException
```
    INTERNAL: Return the descriptor for the root object.
    
    Throws:
    
    XMLMarshalException
  - getDescriptor
```
public DESCRIPTOR getDescriptor(java.lang.Object object)
                         throws XMLMarshalException
```
    INTERNAL: Return the descriptor for the root object.
    
    Throws:
    
    XMLMarshalException
  - getDescriptor
```
protected DESCRIPTOR getDescriptor(java.lang.Object object,
                                   ABSTRACT_SESSION session)
                            throws XMLMarshalException
```
    INTERNAL: Return the descriptor for the root object.
    
    Throws:
    
    XMLMarshalException
  - getDescriptor
```
protected DESCRIPTOR getDescriptor(java.lang.Object object,
                                   boolean isXMLRoot)
```
  - getDescriptor
```
protected DESCRIPTOR getDescriptor(Root object)
                            throws XMLMarshalException
```
    Throws:
    
    XMLMarshalException
  - getDescriptor
```
protected DESCRIPTOR getDescriptor(Root object,
                                   ABSTRACT_SESSION session)
                            throws XMLMarshalException
```
    Throws:
    
    XMLMarshalException
  - getNode
```
protected org.w3c.dom.Node getNode(java.lang.Object object,
                                   org.w3c.dom.Node parentNode,
                                   ABSTRACT_SESSION session,
                                   DESCRIPTOR descriptor,
                                   boolean isRoot)
```
  - getNoNamespaceSchemaLocation
```
public java.lang.String getNoNamespaceSchemaLocation()
```
    Get the no namespace schema location set on this XMLMarshaller
    
    Returns:
    
    the no namespace schema location specified on this XMLMarshaller
  - getSchema
```
public javax.xml.validation.Schema getSchema()
```
  - getTransformer
```
public XMLTransformer getTransformer()
```
    INTERNAL
    
    Specified by:
    
    getTransformer in class Marshaller<CHARACTER_ESCAPE_HANDLER extends CharacterEscapeHandler,CONTEXT extends Context<ABSTRACT_SESSION,DESCRIPTOR,?,?,?,SESSION,?>,MARSHALLER_LISTENER extends Marshaller.Listener,MEDIA_TYPE extends MediaType,NAMESPACE_PREFIX_MAPPER extends NamespacePrefixMapper>
    
    Returns:
    
    the transformer instance for this marshaller
  - getValueWrapper
```
public java.lang.String getValueWrapper()
```
    Name of the property to marshal/unmarshal as a wrapper on the text() mappings Ignored marshalling XML.
    
    Since:
    
    2.4
  - getXmlHeader
```
public java.lang.String getXmlHeader()
```
    Get this Marshaller's XML Header.
    
    Since:
    
    2.4
  - getSchemaLocation
```
public java.lang.String getSchemaLocation()
```
    Get the schema location set on this XMLMarshaller
    
    Returns:
    
    the schema location specified on this XMLMarshaller
  - isApplicationJSON
```
public boolean isApplicationJSON()
```
    INTERNAL
    
    Specified by:
    
    isApplicationJSON in class Marshaller<CHARACTER_ESCAPE_HANDLER extends CharacterEscapeHandler,CONTEXT extends Context<ABSTRACT_SESSION,DESCRIPTOR,?,?,?,SESSION,?>,MARSHALLER_LISTENER extends Marshaller.Listener,MEDIA_TYPE extends MediaType,NAMESPACE_PREFIX_MAPPER extends NamespacePrefixMapper>
    
    Returns:
    
    true if the media type is application/json, else false.
    
    Since:
    
    EclipseLink 2.6.0
  - isApplicationXML
```
public boolean isApplicationXML()
```
    INTERNAL
    
    Specified by:
    
    isApplicationXML in class Marshaller<CHARACTER_ESCAPE_HANDLER extends CharacterEscapeHandler,CONTEXT extends Context<ABSTRACT_SESSION,DESCRIPTOR,?,?,?,SESSION,?>,MARSHALLER_LISTENER extends Marshaller.Listener,MEDIA_TYPE extends MediaType,NAMESPACE_PREFIX_MAPPER extends NamespacePrefixMapper>
    
    Returns:
    
    true if the media type is application/xml, else false.
    
    Since:
    
    EclipseLink 2.6.0
  - isFragment
```
public boolean isFragment()
```
    PUBLIC: Returns if this should marshal to a fragment. If true an XML header string is not written out.
    
    Returns:
    
    if this should marshal to a fragment or not
  - isIncludeRoot
```
public boolean isIncludeRoot()
```
    Determine if the @XMLRootElement should be marshalled when present. Ignored marshalling XML.
    
    Specified by:
    
    isIncludeRoot in class Marshaller<CHARACTER_ESCAPE_HANDLER extends CharacterEscapeHandler,CONTEXT extends Context<ABSTRACT_SESSION,DESCRIPTOR,?,?,?,SESSION,?>,MARSHALLER_LISTENER extends Marshaller.Listener,MEDIA_TYPE extends MediaType,NAMESPACE_PREFIX_MAPPER extends NamespacePrefixMapper>
    
    Returns:
    
    Since:
    
    2.4
  - isReduceAnyArrays
```
public boolean isReduceAnyArrays()
```
    Property to determine if size 1 any collections should be treated as collections Ignored marshalling XML.
    
    Specified by:
    
    isReduceAnyArrays in class Marshaller<CHARACTER_ESCAPE_HANDLER extends CharacterEscapeHandler,CONTEXT extends Context<ABSTRACT_SESSION,DESCRIPTOR,?,?,?,SESSION,?>,MARSHALLER_LISTENER extends Marshaller.Listener,MEDIA_TYPE extends MediaType,NAMESPACE_PREFIX_MAPPER extends NamespacePrefixMapper>
  - getNamespaceSeparator
```
public char getNamespaceSeparator()
```
    Get the namespace separator used during marshal operations. If mediaType is application/json '.' is the default Ignored marshalling XML.
    
    Since:
    
    2.4
  - isMarshalEmptyCollections
```
public boolean isMarshalEmptyCollections()
```
    Name of the property to determine if empty collections should be marshalled as [] Ignored marshalling XML.
    
    Since:
    
    2.4
  - isWrapperAsCollectionName
```
public boolean isWrapperAsCollectionName()
```
    Specified by:
    
    isWrapperAsCollectionName in class Marshaller<CHARACTER_ESCAPE_HANDLER extends CharacterEscapeHandler,CONTEXT extends Context<ABSTRACT_SESSION,DESCRIPTOR,?,?,?,SESSION,?>,MARSHALLER_LISTENER extends Marshaller.Listener,MEDIA_TYPE extends MediaType,NAMESPACE_PREFIX_MAPPER extends NamespacePrefixMapper>
  - isSimpleXMLRoot
```
protected boolean isSimpleXMLRoot(Root xmlRoot)
```
  - marshal
```
public void marshal(java.lang.Object object,
                    org.xml.sax.ContentHandler contentHandler)
             throws XMLMarshalException
```
    PUBLIC: Convert the given object to XML and update the given contentHandler with that XML Document
    
    Parameters:
    
    object - the object to marshal
    
    contentHandler - the contentHandler which the specified object should be marshalled to
    
    Throws:
    
    XMLMarshalException - if an error occurred during marshalling
  - marshal
```
public void marshal(java.lang.Object object,
                    org.xml.sax.ContentHandler contentHandler,
                    org.xml.sax.ext.LexicalHandler lexicalHandler)
             throws XMLMarshalException
```
    PUBLIC: Convert the given object to XML and update the given contentHandler with that XML Document
    
    Parameters:
    
    object - the object to marshal
    
    contentHandler - the contentHandler which the specified object should be marshalled to
    
    Throws:
    
    XMLMarshalException - if an error occurred during marshalling
  - marshal
```
public void marshal(java.lang.Object object,
                    MarshalRecord marshalRecord)
```
    Convert the given object to XML and update the given marshal record with that XML Document.
    
    Parameters:
    
    object - the object to marshal
    
    marshalRecord - the marshalRecord to marshal the object to
  - marshal
```
protected void marshal(java.lang.Object object,
                       MarshalRecord marshalRecord,
                       ABSTRACT_SESSION session,
                       DESCRIPTOR descriptor,
                       boolean isXMLRoot)
```
    Convert the given object to XML and update the given marshal record with that XML Document.
    
    Parameters:
    
    object - the object to marshal
    
    marshalRecord - the marshalRecord to marshal the object to
    
    descriptor - the XMLDescriptor for the object being marshalled
  - marshal
```
public void marshal(java.lang.Object object,
                    org.w3c.dom.Node node)
             throws XMLMarshalException
```
    PUBLIC:
    
    Parameters:
    
    object - the object to marshal
    
    node - the node which the specified object should be marshalled to
    
    Throws:
    
    XMLMarshalException - if an error occurred during marshalling
  - marshal
```
public void marshal(java.lang.Object object,
                    java.io.OutputStream outputStream)
             throws XMLMarshalException
```
    PUBLIC: Convert the given object to XML and update the given outputStream with that XML Document
    
    Parameters:
    
    object - the object to marshal
    
    outputStream - the outputStream to marshal the object to
    
    Throws:
    
    XMLMarshalException - if an error occurred during marshalling
  - marshal
```
public void marshal(java.lang.Object object,
                    javax.xml.transform.Result result)
             throws XMLMarshalException
```
    PUBLIC: Convert the given object to XML and update the given result with that XML Document
    
    Parameters:
    
    object - the object to marshal
    
    result - the result to marshal the object to
    
    Throws:
    
    XMLMarshalException - if an error occurred during marshalling
  - marshal
```
public void marshal(java.lang.Object object,
                    java.io.Writer writer)
             throws XMLMarshalException
```
    PUBLIC: Convert the given object to XML and update the given writer with that XML Document
    
    Parameters:
    
    object - the object to marshal
    
    writer - the writer to marshal the object to
    
    Throws:
    
    XMLMarshalException - if an error occurred during marshalling
  - objectToXML
```
public org.w3c.dom.Document objectToXML(java.lang.Object object)
                                 throws XMLMarshalException
```
    PUBLIC: Convert the given object to an XML Document
    
    Parameters:
    
    object - the object to marshal
    
    Returns:
    
    the document which the specified object has been marshalled to
    
    Throws:
    
    XMLMarshalException - if an error occurred during marshalling
  - objectToXML
```
protected org.w3c.dom.Document objectToXML(java.lang.Object object,
                                           DESCRIPTOR descriptor,
                                           boolean isXMLRoot)
                                    throws XMLMarshalException
```
    INTERNAL: Convert the given object to an XML Document
    
    Parameters:
    
    object - the object to marshal
    
    descriptor - the XMLDescriptor for the object being marshalled
    
    Returns:
    
    the document which the specified object has been marshalled to
    
    Throws:
    
    XMLMarshalException - if an error occurred during marshalling
  - objectToXMLNode
```
protected org.w3c.dom.Node objectToXMLNode(java.lang.Object object,
                                           ABSTRACT_SESSION session,
                                           DESCRIPTOR descriptor,
                                           boolean isXMLRoot)
                                    throws XMLMarshalException
```
    INTERNAL: Like ObjectToXML but is may also return a document fragment instead of a document in the case of a non-root object.
    
    Throws:
    
    XMLMarshalException
  - objectToXMLNode
```
protected org.w3c.dom.Node objectToXMLNode(java.lang.Object object,
                                           org.w3c.dom.Node rootNode,
                                           ABSTRACT_SESSION session,
                                           DESCRIPTOR descriptor,
                                           boolean isXMLRoot)
                                    throws XMLMarshalException
```
    Throws:
    
    XMLMarshalException
  - setAttachmentMarshaller
```
public void setAttachmentMarshaller(XMLAttachmentMarshaller atm)
```
  - setAttributePrefix
```
public void setAttributePrefix(java.lang.String attributePrefix)
```
    Value that will be used to prefix attributes. Ignored marshalling XML.
    
    Since:
    
    2.4
  - setEncoding
```
public void setEncoding(java.lang.String newEncoding)
```
    Set the encoding on this XMLMarshaller If the encoding is not set the default UTF-8 will be used
    
    Overrides:
    
    setEncoding in class Marshaller<CHARACTER_ESCAPE_HANDLER extends CharacterEscapeHandler,CONTEXT extends Context<ABSTRACT_SESSION,DESCRIPTOR,?,?,?,SESSION,?>,MARSHALLER_LISTENER extends Marshaller.Listener,MEDIA_TYPE extends MediaType,NAMESPACE_PREFIX_MAPPER extends NamespacePrefixMapper>
    
    Parameters:
    
    newEncoding - the encoding to set on this XMLMarshaller
  - setFormattedOutput
```
public void setFormattedOutput(boolean shouldFormat)
```
    Set if this XMLMarshaller should format the XML By default this is set to true and the XML marshalled will be formatted.
    
    Overrides:
    
    setFormattedOutput in class Marshaller<CHARACTER_ESCAPE_HANDLER extends CharacterEscapeHandler,CONTEXT extends Context<ABSTRACT_SESSION,DESCRIPTOR,?,?,?,SESSION,?>,MARSHALLER_LISTENER extends Marshaller.Listener,MEDIA_TYPE extends MediaType,NAMESPACE_PREFIX_MAPPER extends NamespacePrefixMapper>
    
    Parameters:
    
    shouldFormat - if this XMLMarshaller should format the XML
  - setFragment
```
public void setFragment(boolean fragment)
```
    PUBLIC: Set if this should marshal to a fragment. If true an XML header string is not written out.
    
    Parameters:
    
    fragment - if this should marshal to a fragment or not
  - setIncludeRoot
```
public void setIncludeRoot(boolean includeRoot)
```
    Determine if the @XMLRootElement should be marshalled when present. Ignored marshalling XML.
    
    Since:
    
    2.4
  - setMarshalEmptyCollections
```
public void setMarshalEmptyCollections(java.lang.Boolean marshalEmptyCollections)
```
    Name of the property to determine if empty collections should be marshalled as [] Ignored marshalling XML.
    
    Since:
    
    2.4
  - setMediaType
```
public void setMediaType(MEDIA_TYPE mediaType)
```
    Set the MediaType for this xmlMarshaller. See org.eclipse.persistence.oxm.MediaType for the media types supported by EclipseLink MOXy
    
    Parameters:
    
    mediaType -
  - setNamespaceSeparator
```
public void setNamespaceSeparator(char namespaceSeparator)
```
    Set the namespace separator used during marshal operations. If mediaType is application/json '.' is the default Ignored marshalling XML.
    
    Since:
    
    2.4
  - setNoNamespaceSchemaLocation
```
public void setNoNamespaceSchemaLocation(java.lang.String newNoNamespaceSchemaLocation)
```
    Set the no namespace schema location on this XMLMarshaller
    
    Parameters:
    
    newNoNamespaceSchemaLocation - no namespace schema location to be seton this XMLMarshaller
  - setReduceAnyArrays
```
public void setReduceAnyArrays(boolean reduceAnyArrays)
```
    Property to determine if size 1 any collections should be treated as collections Ignored marshalling XML.
  - setSchema
```
public void setSchema(javax.xml.validation.Schema schema)
```
  - setSchemaLocation
```
public void setSchemaLocation(java.lang.String newSchemaLocation)
```
    Set the schema location on this XMLMarshaller
    
    Parameters:
    
    newSchemaLocation - the schema location to be seton this XMLMarshaller
  - setWrapperAsCollectionName
```
public void setWrapperAsCollectionName(boolean wrapperAsCollectionName)
```
  - setValueWrapper
```
public void setValueWrapper(java.lang.String valueWrapper)
```
    Name of the property to marshal/unmarshal as a wrapper on the text() mappings Ignored marshalling XML.
    
    Since:
    
    2.4
  - setXmlHeader
```
public void setXmlHeader(java.lang.String xmlHeader)
```
    Set this Marshaller's XML Header. This header string will appear after the XML processing instruction (<?xml ...>), but before the start of the document's data.
    
    This feature is only supported when marshalling to Stream, Writer, or StreamResult.
    
    Since:
    
    2.4
  - setMarshalAttributeGroup
```
public void setMarshalAttributeGroup(java.lang.Object group)
```
  - getMarshalAttributeGroup
```
public java.lang.Object getMarshalAttributeGroup()
```
  - isLogPayload
```
public java.lang.Boolean isLogPayload()
```
  - setLogPayload
```
public void setLogPayload(java.lang.Boolean logPayload)
```

Modifier	Constructor	Description
	`XMLMarshaller(CONTEXT context)`
`protected`	`XMLMarshaller(XMLMarshaller xmlMarshaller)`	Copy constructor

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.persistence.internal.oxm.Marshaller

Field Summary

Fields inherited from class org.eclipse.persistence.internal.oxm.Marshaller

Constructor Summary

Method Summary

Methods inherited from class org.eclipse.persistence.internal.oxm.Marshaller

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_XML_VERSION

staxResultClass

staxResultGetStreamWriterMethod

staxResultGetEventWriterMethod

writeToStreamMethod

writeToEventWriterMethod

domToStreamWriterClass

domToEventWriterClass

attachmentMarshaller

mediaType

transformer

Constructor Detail

XMLMarshaller

XMLMarshaller

Method Detail

addDescriptorNamespacesToXMLRecord

copyNamespaces

getAttachmentMarshaller

getAttributePrefix

getDescriptor

getDescriptor

getDescriptor

getDescriptor

getDescriptor

getDescriptor

getNode

getNoNamespaceSchemaLocation

getSchema

getTransformer

getValueWrapper

getXmlHeader

getSchemaLocation

isApplicationJSON

isApplicationXML

isFragment

isIncludeRoot

isReduceAnyArrays

getNamespaceSeparator

isMarshalEmptyCollections

isWrapperAsCollectionName

isSimpleXMLRoot

marshal

marshal

marshal

marshal

marshal

marshal

marshal

marshal

objectToXML

objectToXML

objectToXMLNode

objectToXMLNode

setAttachmentMarshaller

setAttributePrefix

setEncoding

setFormattedOutput

setFragment

setIncludeRoot

setMarshalEmptyCollections

setMediaType

setNamespaceSeparator

setNoNamespaceSchemaLocation

setReduceAnyArrays

setSchema

setSchemaLocation

setWrapperAsCollectionName

setValueWrapper

setXmlHeader

setMarshalAttributeGroup

getMarshalAttributeGroup