Package org.eclipse.persistence.jaxb

Class JAXBMarshaller

  • All Implemented Interfaces:
    javax.xml.bind.Marshaller
    public class JAXBMarshaller
extends java.lang.Object
implements javax.xml.bind.Marshaller
    INTERNAL:

    Purpose:To Provide an implementation of the JAXB 2.0 Marshaller Interface

    Responsibilities:

    • Provide a JAXB wrapper on the XMLMarshaller API
    • Perform Object to XML Conversions

    This implementation of the JAXB 2.1/2.2 Marshaller interface provides the required functionality by acting as a thin wrapper on the existing XMLMarshaller API.

    Since:
    Oracle TopLink 11.1.1.0.0
    Author:
    mmacivor
    See Also:
    Marshaller, MarshallerProperties, XMLMarshaller

    • Nested Class Summary

      • Nested classes/interfaces inherited from interface javax.xml.bind.Marshaller

        javax.xml.bind.Marshaller.Listener

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String XML_JAVATYPE_ADAPTERS  

      • Fields inherited from interface javax.xml.bind.Marshaller

        JAXB_ENCODING, JAXB_FORMATTED_OUTPUT, JAXB_FRAGMENT, JAXB_NO_NAMESPACE_SCHEMA_LOCATION, JAXB_SCHEMA_LOCATION

    • Constructor Summary

      Constructors 
      Constructor Description
      JAXBMarshaller​(org.eclipse.persistence.oxm.XMLMarshaller newXMLMarshaller, JAXBContext jaxbContext)
      This constructor initializes various settings on the XML marshaller.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      javax.xml.bind.annotation.adapters.XmlAdapter getAdapter​(java.lang.Class javaClass)  
      javax.xml.bind.attachment.AttachmentMarshaller getAttachmentMarshaller()  
      java.util.Set<ConstraintViolationWrapper<java.lang.Object>> getConstraintViolations()
      Returns constraint violations stored in the underlying JAXBBeanValidator instance.
      javax.xml.bind.ValidationEventHandler getEventHandler()  
      JAXBContext getJaxbContext()  
      javax.xml.bind.Marshaller.Listener getListener()  
      org.w3c.dom.Node getNode​(java.lang.Object object)  
      java.lang.Object getProperty​(java.lang.String key)
      Get a property from the JAXBMarshaller.
      javax.xml.validation.Schema getSchema()  
      org.eclipse.persistence.oxm.XMLMarshaller getXMLMarshaller()  
      void marshal​(java.lang.Object object, java.io.File file)  
      void marshal​(java.lang.Object object, java.io.OutputStream outputStream)  
      void marshal​(java.lang.Object object, java.io.Writer writer)  
      void marshal​(java.lang.Object object, javax.xml.stream.XMLEventWriter eventWriter)  
      void marshal​(java.lang.Object object, javax.xml.stream.XMLEventWriter eventWriter, TypeMappingInfo type)  
      void marshal​(java.lang.Object object, javax.xml.stream.XMLStreamWriter streamWriter)  
      void marshal​(java.lang.Object object, javax.xml.stream.XMLStreamWriter streamWriter, TypeMappingInfo type)  
      void marshal​(java.lang.Object object, javax.xml.transform.Result result)  
      void marshal​(java.lang.Object object, javax.xml.transform.Result result, TypeMappingInfo type)  
      void marshal​(java.lang.Object object, org.eclipse.persistence.oxm.record.MarshalRecord record)  
      void marshal​(java.lang.Object object, org.eclipse.persistence.oxm.record.MarshalRecord record, TypeMappingInfo type)  
      void marshal​(java.lang.Object object, org.w3c.dom.Node node)  
      void marshal​(java.lang.Object object, org.xml.sax.ContentHandler contentHandler)  
      void setAdapter​(java.lang.Class javaClass, javax.xml.bind.annotation.adapters.XmlAdapter adapter)  
      void setAdapter​(javax.xml.bind.annotation.adapters.XmlAdapter adapter)  
      void setAttachmentMarshaller​(javax.xml.bind.attachment.AttachmentMarshaller attachmentMarshaller)  
      void setEventHandler​(javax.xml.bind.ValidationEventHandler newValidationEventHandler)  
      void setListener​(javax.xml.bind.Marshaller.Listener listener)  
      void setMarshalCallbacks​(java.util.Map callbacks)  
      void setProperty​(java.lang.String key, java.lang.Object value)
      Set a property on the JAXBMarshaller.
      void setSchema​(javax.xml.validation.Schema schema)  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • XML_JAVATYPE_ADAPTERS

        public static final java.lang.String XML_JAVATYPE_ADAPTERS
        See Also:
        Constant Field Values

    • Constructor Detail

      • JAXBMarshaller

        public JAXBMarshaller​(org.eclipse.persistence.oxm.XMLMarshaller newXMLMarshaller,
                      JAXBContext jaxbContext)
        This constructor initializes various settings on the XML marshaller.
        Parameters:
        newXMLMarshaller - xml marshaller
        jaxbContext - jaxb context

    • Method Detail

      • getAdapter

        public javax.xml.bind.annotation.adapters.XmlAdapter getAdapter​(java.lang.Class javaClass)
        Specified by:
        getAdapter in interface javax.xml.bind.Marshaller

      • getAttachmentMarshaller

        public javax.xml.bind.attachment.AttachmentMarshaller getAttachmentMarshaller()
        Specified by:
        getAttachmentMarshaller in interface javax.xml.bind.Marshaller

      • getEventHandler

        public javax.xml.bind.ValidationEventHandler getEventHandler()
                                                      throws javax.xml.bind.JAXBException
        Specified by:
        getEventHandler in interface javax.xml.bind.Marshaller
        Throws:
        javax.xml.bind.JAXBException

      • getListener

        public javax.xml.bind.Marshaller.Listener getListener()
        Specified by:
        getListener in interface javax.xml.bind.Marshaller

      • getNode

        public org.w3c.dom.Node getNode​(java.lang.Object object)
                         throws javax.xml.bind.JAXBException
        Specified by:
        getNode in interface javax.xml.bind.Marshaller
        Throws:
        javax.xml.bind.JAXBException

      • getProperty

        public java.lang.Object getProperty​(java.lang.String key)
                             throws javax.xml.bind.PropertyException
        Get a property from the JAXBMarshaller. Attempting to get any unsupported property will result in a javax.xml.bind.PropertyException
        Specified by:
        getProperty in interface javax.xml.bind.Marshaller
        Throws:
        javax.xml.bind.PropertyException
        See Also:
        MarshallerProperties

      • getSchema

        public javax.xml.validation.Schema getSchema()
        Specified by:
        getSchema in interface javax.xml.bind.Marshaller

      • marshal

        public void marshal​(java.lang.Object object,
                    org.xml.sax.ContentHandler contentHandler)
             throws javax.xml.bind.JAXBException
        Specified by:
        marshal in interface javax.xml.bind.Marshaller
        Throws:
        javax.xml.bind.JAXBException

      • marshal

        public void marshal​(java.lang.Object object,
                    javax.xml.stream.XMLEventWriter eventWriter)
             throws javax.xml.bind.JAXBException
        Specified by:
        marshal in interface javax.xml.bind.Marshaller
        Throws:
        javax.xml.bind.JAXBException

      • marshal

        public void marshal​(java.lang.Object object,
                    javax.xml.stream.XMLEventWriter eventWriter,
                    TypeMappingInfo type)
             throws javax.xml.bind.JAXBException
        Throws:
        javax.xml.bind.JAXBException

      • marshal

        public void marshal​(java.lang.Object object,
                    org.w3c.dom.Node node)
             throws javax.xml.bind.JAXBException
        Specified by:
        marshal in interface javax.xml.bind.Marshaller
        Throws:
        javax.xml.bind.JAXBException

      • marshal

        public void marshal​(java.lang.Object object,
                    java.io.OutputStream outputStream)
             throws javax.xml.bind.JAXBException
        Specified by:
        marshal in interface javax.xml.bind.Marshaller
        Throws:
        javax.xml.bind.JAXBException

      • marshal

        public void marshal​(java.lang.Object object,
                    java.io.File file)
             throws javax.xml.bind.JAXBException
        Specified by:
        marshal in interface javax.xml.bind.Marshaller
        Throws:
        javax.xml.bind.JAXBException

      • marshal

        public void marshal​(java.lang.Object object,
                    javax.xml.transform.Result result)
             throws javax.xml.bind.JAXBException
        Specified by:
        marshal in interface javax.xml.bind.Marshaller
        Throws:
        javax.xml.bind.JAXBException

      • marshal

        public void marshal​(java.lang.Object object,
                    javax.xml.transform.Result result,
                    TypeMappingInfo type)
             throws javax.xml.bind.JAXBException
        Throws:
        javax.xml.bind.JAXBException

      • marshal

        public void marshal​(java.lang.Object object,
                    javax.xml.stream.XMLStreamWriter streamWriter)
             throws javax.xml.bind.JAXBException
        Specified by:
        marshal in interface javax.xml.bind.Marshaller
        Throws:
        javax.xml.bind.JAXBException

      • marshal

        public void marshal​(java.lang.Object object,
                    javax.xml.stream.XMLStreamWriter streamWriter,
                    TypeMappingInfo type)
             throws javax.xml.bind.JAXBException
        Throws:
        javax.xml.bind.JAXBException

      • marshal

        public void marshal​(java.lang.Object object,
                    java.io.Writer writer)
             throws javax.xml.bind.JAXBException
        Specified by:
        marshal in interface javax.xml.bind.Marshaller
        Throws:
        javax.xml.bind.JAXBException

      • marshal

        public void marshal​(java.lang.Object object,
                    org.eclipse.persistence.oxm.record.MarshalRecord record)
             throws javax.xml.bind.JAXBException
        Throws:
        javax.xml.bind.JAXBException

      • marshal

        public void marshal​(java.lang.Object object,
                    org.eclipse.persistence.oxm.record.MarshalRecord record,
                    TypeMappingInfo type)
             throws javax.xml.bind.JAXBException
        Throws:
        javax.xml.bind.JAXBException

      • setAdapter

        public void setAdapter​(java.lang.Class javaClass,
                       javax.xml.bind.annotation.adapters.XmlAdapter adapter)
        Specified by:
        setAdapter in interface javax.xml.bind.Marshaller

      • setAdapter

        public void setAdapter​(javax.xml.bind.annotation.adapters.XmlAdapter adapter)
        Specified by:
        setAdapter in interface javax.xml.bind.Marshaller

      • setAttachmentMarshaller

        public void setAttachmentMarshaller​(javax.xml.bind.attachment.AttachmentMarshaller attachmentMarshaller)
        Specified by:
        setAttachmentMarshaller in interface javax.xml.bind.Marshaller

      • setEventHandler

        public void setEventHandler​(javax.xml.bind.ValidationEventHandler newValidationEventHandler)
                     throws javax.xml.bind.JAXBException
        Specified by:
        setEventHandler in interface javax.xml.bind.Marshaller
        Throws:
        javax.xml.bind.JAXBException

      • setListener

        public void setListener​(javax.xml.bind.Marshaller.Listener listener)
        Specified by:
        setListener in interface javax.xml.bind.Marshaller

      • setMarshalCallbacks

        public void setMarshalCallbacks​(java.util.Map callbacks)

      • setProperty

        public void setProperty​(java.lang.String key,
                        java.lang.Object value)
                 throws javax.xml.bind.PropertyException
        Set a property on the JAXBMarshaller. Attempting to set any unsupported property will result in a javax.xml.bind.PropertyException
        Specified by:
        setProperty in interface javax.xml.bind.Marshaller
        Throws:
        javax.xml.bind.PropertyException
        See Also:
        MarshallerProperties

      • setSchema

        public void setSchema​(javax.xml.validation.Schema schema)
        Specified by:
        setSchema in interface javax.xml.bind.Marshaller

      • getXMLMarshaller

        public org.eclipse.persistence.oxm.XMLMarshaller getXMLMarshaller()

      • getConstraintViolations

        public java.util.Set<ConstraintViolationWrapper<java.lang.Object>> getConstraintViolations()
        Returns constraint violations stored in the underlying JAXBBeanValidator instance.
        Returns:
        set of constraint violations from last unmarshal