Package org.eclipse.persistence.oxm
Class XMLMarshaller
- 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<org.eclipse.persistence.internal.sessions.AbstractSession,CharacterEscapeHandler,XMLContext,XMLDescriptor,XMLMarshalListener,MediaType,NamespacePrefixMapper,org.eclipse.persistence.internal.oxm.TreeObjectBuilder,DatabaseSession>
-
- org.eclipse.persistence.oxm.XMLMarshaller
-
- All Implemented Interfaces:
java.lang.Cloneable
public class XMLMarshaller extends org.eclipse.persistence.internal.oxm.XMLMarshaller<org.eclipse.persistence.internal.sessions.AbstractSession,CharacterEscapeHandler,XMLContext,XMLDescriptor,XMLMarshalListener,MediaType,NamespacePrefixMapper,org.eclipse.persistence.internal.oxm.TreeObjectBuilder,DatabaseSession> implements java.lang.Cloneable
Class used to marshal object to XML.
Create an XMLMarshaller from an XMLContext.
Code Sample
XMLContext context = new XMLContext("mySessionName");
XMLMarshaller marshaller = context.createMarshaller();
Objects can be marshalled to the following outputs:
- java.io.OutputStream
- java.io.Writer
- javax.xml.transform.Result
- org.w3c.dom.Node
- org.xml.sax.ContentHandler
Objects that can be marshalled are those which are mapped in the TopLink project associated with the XMLContext, and which are mapped to an XMLDescriptor that has a default root element specified.
- See Also:
XMLContext
-
-
Constructor Summary
Constructors Constructor Description XMLMarshaller(XMLContext xmlContext)
Create a new XMLMarshaller based on the specified session
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description XMLMarshaller
clone()
CharacterEscapeHandler
getCharacterEscapeHandler()
Return this Marshaller's CharacterEscapeHandler.org.eclipse.persistence.internal.oxm.JsonTypeConfiguration
getJsonTypeConfiguration()
Returns json type configuration.XMLMarshalListener
getMarshalListener()
MediaType
getMediaType()
Get the MediaType for this xmlMarshaller.NamespacePrefixMapper
getNamespacePrefixMapper()
NamespacePrefixMapper that can be used during marshal (instead of those set in the project meta data)java.util.Properties
getProperties()
Return a properties object for a given instance of the XMLMarshaller.XMLContext
getXMLContext()
Return the instance of XMLContext that was used to create this instance of XMLMarshaller.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 Documentorg.w3c.dom.Document
objectToXML(java.lang.Object object, XMLDescriptor descriptor, XMLRecord xmlRow, boolean isXMLRoot, DocumentPreservationPolicy docPresPolicy)
INTERNAL: Convert the given object to an XML Documentorg.w3c.dom.Document
objectToXML(java.lang.Object object, org.w3c.dom.Node parent)
Deprecated.org.w3c.dom.Document
objectToXML(java.lang.Object object, org.w3c.dom.Node parent, DocumentPreservationPolicy docPresPolicy)
org.w3c.dom.Document
objectToXML(java.lang.Object object, org.w3c.dom.Node rootNode, XMLDescriptor descriptor, XMLRecord xmlRow, boolean isXMLRoot, DocumentPreservationPolicy docPresPolicy)
void
setCharacterEscapeHandler(CharacterEscapeHandler c)
Set this Marshaller's CharacterEscapeHandler.void
setMarshalListener(XMLMarshalListener listener)
void
setMediaType(MediaType mediaType)
Set the MediaType for this xmlMarshaller.void
setNamespacePrefixMapper(NamespacePrefixMapper mapper)
NamespacePrefixMapper that can be used during marshal (instead of those set in the project meta data)void
setXMLContext(XMLContext value)
Set the XMLContext used by this instance of XMLMarshaller.void
setXMLMarshalHandler(XMLMarshalListener marshalListener)
-
Methods inherited from class org.eclipse.persistence.internal.oxm.XMLMarshaller
getAttachmentMarshaller, getAttributePrefix, getDescriptor, getMarshalAttributeGroup, getNamespaceSeparator, getNoNamespaceSchemaLocation, getSchema, getSchemaLocation, getTransformer, getValueWrapper, getXmlHeader, isApplicationJSON, isApplicationXML, isFragment, isIncludeRoot, isMarshalEmptyCollections, isReduceAnyArrays, isWrapperAsCollectionName, marshal, marshal, marshal, marshal, marshal, marshal, objectToXML, setAttachmentMarshaller, setAttributePrefix, setEncoding, setFormattedOutput, setFragment, setIncludeRoot, setMarshalAttributeGroup, setMarshalEmptyCollections, setNamespaceSeparator, setNoNamespaceSchemaLocation, setReduceAnyArrays, setSchema, setSchemaLocation, setValueWrapper, setWrapperAsCollectionName, setXmlHeader
-
-
-
-
Constructor Detail
-
XMLMarshaller
public XMLMarshaller(XMLContext xmlContext)
Create a new XMLMarshaller based on the specified session- Parameters:
xmlContext
- the XML content
-
-
Method Detail
-
getXMLContext
public XMLContext getXMLContext()
Return the instance of XMLContext that was used to create this instance of XMLMarshaller.
-
setXMLContext
public void setXMLContext(XMLContext value)
Set the XMLContext used by this instance of XMLMarshaller.
-
getProperties
public java.util.Properties getProperties()
Return a properties object for a given instance of the XMLMarshaller.- Returns:
-
setXMLMarshalHandler
public void setXMLMarshalHandler(XMLMarshalListener marshalListener)
-
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- Overrides:
marshal
in classorg.eclipse.persistence.internal.oxm.XMLMarshaller<org.eclipse.persistence.internal.sessions.AbstractSession,CharacterEscapeHandler,XMLContext,XMLDescriptor,XMLMarshalListener,MediaType,NamespacePrefixMapper,org.eclipse.persistence.internal.oxm.TreeObjectBuilder,DatabaseSession>
- Parameters:
object
- the object to marshalresult
- the result to marshal the object to- Throws:
XMLMarshalException
- if an error occurred during marshalling
-
getMarshalListener
public XMLMarshalListener getMarshalListener()
- Overrides:
getMarshalListener
in classorg.eclipse.persistence.internal.oxm.Marshaller<CharacterEscapeHandler,XMLContext,XMLMarshalListener,MediaType,NamespacePrefixMapper>
-
setMarshalListener
public void setMarshalListener(XMLMarshalListener listener)
- Overrides:
setMarshalListener
in classorg.eclipse.persistence.internal.oxm.Marshaller<CharacterEscapeHandler,XMLContext,XMLMarshalListener,MediaType,NamespacePrefixMapper>
-
objectToXML
public org.w3c.dom.Document objectToXML(java.lang.Object object, org.w3c.dom.Node parent) throws XMLMarshalException
Deprecated.PUBLIC: Convert the given object to descendants of the parent element- Parameters:
object
- the object to marshalparent
- the node to marshal the object to- Returns:
- the document which the specified object has been marshalled to
- Throws:
XMLMarshalException
- if an error occurred during marshalling
-
objectToXML
public org.w3c.dom.Document objectToXML(java.lang.Object object, org.w3c.dom.Node parent, DocumentPreservationPolicy docPresPolicy)
-
objectToXML
public org.w3c.dom.Document objectToXML(java.lang.Object object, XMLDescriptor descriptor, XMLRecord xmlRow, boolean isXMLRoot, DocumentPreservationPolicy docPresPolicy)
INTERNAL: Convert the given object to an XML Document
-
objectToXML
public org.w3c.dom.Document objectToXML(java.lang.Object object, org.w3c.dom.Node rootNode, XMLDescriptor descriptor, XMLRecord xmlRow, boolean isXMLRoot, DocumentPreservationPolicy docPresPolicy)
-
clone
public XMLMarshaller clone()
-
setNamespacePrefixMapper
public void setNamespacePrefixMapper(NamespacePrefixMapper mapper)
NamespacePrefixMapper that can be used during marshal (instead of those set in the project meta data)- Overrides:
setNamespacePrefixMapper
in classorg.eclipse.persistence.internal.oxm.Marshaller<CharacterEscapeHandler,XMLContext,XMLMarshalListener,MediaType,NamespacePrefixMapper>
- Since:
- 2.3.3
-
getNamespacePrefixMapper
public NamespacePrefixMapper getNamespacePrefixMapper()
NamespacePrefixMapper that can be used during marshal (instead of those set in the project meta data)- Overrides:
getNamespacePrefixMapper
in classorg.eclipse.persistence.internal.oxm.Marshaller<CharacterEscapeHandler,XMLContext,XMLMarshalListener,MediaType,NamespacePrefixMapper>
- Returns:
- Since:
- 2.3.3
-
getCharacterEscapeHandler
public CharacterEscapeHandler getCharacterEscapeHandler()
Return this Marshaller's CharacterEscapeHandler.- Overrides:
getCharacterEscapeHandler
in classorg.eclipse.persistence.internal.oxm.Marshaller<CharacterEscapeHandler,XMLContext,XMLMarshalListener,MediaType,NamespacePrefixMapper>
- Since:
- 2.3.3
-
setCharacterEscapeHandler
public void setCharacterEscapeHandler(CharacterEscapeHandler c)
Set this Marshaller's CharacterEscapeHandler.- Overrides:
setCharacterEscapeHandler
in classorg.eclipse.persistence.internal.oxm.Marshaller<CharacterEscapeHandler,XMLContext,XMLMarshalListener,MediaType,NamespacePrefixMapper>
- Since:
- 2.3.3
-
setMediaType
public void setMediaType(MediaType mediaType)
Set the MediaType for this xmlMarshaller. See org.eclipse.persistence.oxm.MediaType for the media types supported by EclipseLink MOXy- Overrides:
setMediaType
in classorg.eclipse.persistence.internal.oxm.XMLMarshaller<org.eclipse.persistence.internal.sessions.AbstractSession,CharacterEscapeHandler,XMLContext,XMLDescriptor,XMLMarshalListener,MediaType,NamespacePrefixMapper,org.eclipse.persistence.internal.oxm.TreeObjectBuilder,DatabaseSession>
- Parameters:
mediaType
-- Since:
- EclipseLink 2.4.0
-
getMediaType
public MediaType getMediaType()
Get the MediaType for this xmlMarshaller. See org.eclipse.persistence.oxm.MediaType for the media types supported by EclipseLink MOXy If not set the default is MediaType.APPLICATION_XML- Returns:
- MediaType
- Since:
- EclipseLink 2.4.0
-
getJsonTypeConfiguration
public org.eclipse.persistence.internal.oxm.JsonTypeConfiguration getJsonTypeConfiguration()
Returns json type configuration.- Specified by:
getJsonTypeConfiguration
in classorg.eclipse.persistence.internal.oxm.Marshaller<CharacterEscapeHandler,XMLContext,XMLMarshalListener,MediaType,NamespacePrefixMapper>
- Returns:
- json type configuration
- Since:
- 2.6.0
-
-