org.eclipse.persistence.oxm

Class XMLMarshaller

    • Constructor Detail

      • XMLMarshaller

        public XMLMarshaller(XMLContext xmlContext)
        Create a new XMLMarshaller based on the specified session
        Parameters:
        session - A single session
    • 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 Properties getProperties()
        Return a properties object for a given instance of the XMLMarshaller.
        Returns:
      • setXMLMarshalHandler

        public void setXMLMarshalHandler(XMLMarshalListener marshalListener)
      • marshal

        public void marshal(Object object,
                   Result result)
                     throws XMLMarshalException
        PUBLIC: Convert the given object to XML and update the given result with that XML Document
        Overrides:
        marshal in class org.eclipse.persistence.internal.oxm.XMLMarshaller<org.eclipse.persistence.internal.sessions.AbstractSession,XMLContext,XMLDescriptor,MediaType,NamespacePrefixMapper,org.eclipse.persistence.internal.oxm.TreeObjectBuilder>
        Parameters:
        object - the object to marshal
        result - the result to marshal the object to
        Throws:
        XMLMarshalException - if an error occurred during marshalling
      • objectToXML

        public Document objectToXML(Object object,
                           Node parent)
                             throws XMLMarshalException
        Deprecated. 
        PUBLIC: Convert the given object to descendants of the parent element
        Parameters:
        object - the object to marshal
        parent - 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
      • 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 class org.eclipse.persistence.internal.oxm.Marshaller<XMLContext,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 class org.eclipse.persistence.internal.oxm.Marshaller<XMLContext,MediaType,NamespacePrefixMapper>
        Returns:
        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 class org.eclipse.persistence.internal.oxm.XMLMarshaller<org.eclipse.persistence.internal.sessions.AbstractSession,XMLContext,XMLDescriptor,MediaType,NamespacePrefixMapper,org.eclipse.persistence.internal.oxm.TreeObjectBuilder>
        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
        Overrides:
        getMediaType in class org.eclipse.persistence.internal.oxm.XMLMarshaller<org.eclipse.persistence.internal.sessions.AbstractSession,XMLContext,XMLDescriptor,MediaType,NamespacePrefixMapper,org.eclipse.persistence.internal.oxm.TreeObjectBuilder>
        Returns:
        MediaType
        Since:
        EclipseLink 2.4.0