Package org.eclipse.persistence.jaxb

Class JAXBUnmarshaller

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

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

    Responsibilities:

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

    This implementation of the JAXB 2.1/2.2 Unmarshaller 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:
    Unmarshaller, UnmarshallerProperties, XMLUnmarshaller

    • Nested Class Summary

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

        javax.xml.bind.Unmarshaller.Listener

    • Constructor Summary

      Constructors 
      Constructor Description
      JAXBUnmarshaller​(org.eclipse.persistence.oxm.XMLUnmarshaller newXMLUnmarshaller, JAXBContext jaxbContext)  

    • 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.AttachmentUnmarshaller getAttachmentUnmarshaller()  
      java.util.Set<ConstraintViolationWrapper<java.lang.Object>> getConstraintViolations()
      Returns constraint violations stored in the underlying JAXBBeanValidator instance.
      javax.xml.bind.ValidationEventHandler getEventHandler()  
      org.eclipse.persistence.oxm.IDResolver getIDResolver()
      Return this Unmarshaller's custom IDResolver.
      JAXBContext getJaxbContext()  
      javax.xml.bind.Unmarshaller.Listener getListener()  
      java.lang.Object getProperty​(java.lang.String key)
      Get a property from the JAXBMarshaller.
      javax.xml.validation.Schema getSchema()  
      javax.xml.bind.UnmarshallerHandler getUnmarshallerHandler()  
      org.eclipse.persistence.oxm.XMLUnmarshaller getXMLUnmarshaller()  
      boolean isValidating()  
      void setAdapter​(java.lang.Class javaClass, javax.xml.bind.annotation.adapters.XmlAdapter adapter)  
      void setAdapter​(javax.xml.bind.annotation.adapters.XmlAdapter adapter)  
      void setAttachmentUnmarshaller​(javax.xml.bind.attachment.AttachmentUnmarshaller unmarshaller)  
      void setEventHandler​(javax.xml.bind.ValidationEventHandler newValidationEventHandler)  
      void setIDResolver​(org.eclipse.persistence.oxm.IDResolver idResolver)
      Set this Unmarshaller's custom IDResolver.
      void setListener​(javax.xml.bind.Unmarshaller.Listener listener)  
      void setProperty​(java.lang.String key, java.lang.Object value)
      Set a property on the JAXBUnmarshaller.
      void setSchema​(javax.xml.validation.Schema schema)  
      void setUnmarshalCallbacks​(java.util.Map callbacks)  
      void setValidating​(boolean validate)  
      java.lang.Object unmarshal​(java.io.File file)  
      java.lang.Object unmarshal​(java.io.InputStream inputStream)  
      java.lang.Object unmarshal​(java.io.Reader reader)  
      java.lang.Object unmarshal​(java.net.URL url)  
      java.lang.Object unmarshal​(javax.xml.stream.XMLEventReader eventReader)  
      javax.xml.bind.JAXBElement unmarshal​(javax.xml.stream.XMLEventReader eventReader, java.lang.Class javaClass)  
      javax.xml.bind.JAXBElement unmarshal​(javax.xml.stream.XMLEventReader eventReader, java.lang.reflect.Type type)  
      javax.xml.bind.JAXBElement unmarshal​(javax.xml.stream.XMLEventReader eventReader, TypeMappingInfo type)
      Unmarshal the object based on the binding metadata associated with the TypeMappingInfo.
      java.lang.Object unmarshal​(javax.xml.stream.XMLStreamReader streamReader)  
      javax.xml.bind.JAXBElement unmarshal​(javax.xml.stream.XMLStreamReader streamReader, java.lang.Class javaClass)  
      javax.xml.bind.JAXBElement unmarshal​(javax.xml.stream.XMLStreamReader streamReader, java.lang.reflect.Type type)  
      javax.xml.bind.JAXBElement unmarshal​(javax.xml.stream.XMLStreamReader streamReader, TypeMappingInfo type)
      Unmarshal the object based on the binding metadata associated with the TypeMappingInfo.
      java.lang.Object unmarshal​(javax.xml.transform.Source source)  
      javax.xml.bind.JAXBElement unmarshal​(javax.xml.transform.Source source, java.lang.Class javaClass)  
      javax.xml.bind.JAXBElement unmarshal​(javax.xml.transform.Source source, java.lang.reflect.Type type)  
      javax.xml.bind.JAXBElement unmarshal​(javax.xml.transform.Source source, TypeMappingInfo type)
      Unmarshal the object based on the binding metadata associated with the TypeMappingInfo.
      java.lang.Object unmarshal​(org.w3c.dom.Node node)  
      javax.xml.bind.JAXBElement unmarshal​(org.w3c.dom.Node node, java.lang.Class javaClass)  
      java.lang.Object unmarshal​(org.xml.sax.InputSource inputSource)  

      • 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

      • STAX_SOURCE_CLASS_NAME

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

    • Constructor Detail

      • JAXBUnmarshaller

        public JAXBUnmarshaller​(org.eclipse.persistence.oxm.XMLUnmarshaller newXMLUnmarshaller,
                        JAXBContext jaxbContext)

    • Method Detail

      • getXMLUnmarshaller

        public org.eclipse.persistence.oxm.XMLUnmarshaller getXMLUnmarshaller()

      • unmarshal

        public java.lang.Object unmarshal​(java.io.File file)
                           throws javax.xml.bind.JAXBException
        Specified by:
        unmarshal in interface javax.xml.bind.Unmarshaller
        Throws:
        javax.xml.bind.JAXBException

      • unmarshal

        public java.lang.Object unmarshal​(java.io.InputStream inputStream)
                           throws javax.xml.bind.JAXBException
        Specified by:
        unmarshal in interface javax.xml.bind.Unmarshaller
        Throws:
        javax.xml.bind.JAXBException

      • unmarshal

        public java.lang.Object unmarshal​(java.net.URL url)
                           throws javax.xml.bind.JAXBException
        Specified by:
        unmarshal in interface javax.xml.bind.Unmarshaller
        Throws:
        javax.xml.bind.JAXBException

      • unmarshal

        public java.lang.Object unmarshal​(org.xml.sax.InputSource inputSource)
                           throws javax.xml.bind.JAXBException
        Specified by:
        unmarshal in interface javax.xml.bind.Unmarshaller
        Throws:
        javax.xml.bind.JAXBException

      • unmarshal

        public java.lang.Object unmarshal​(java.io.Reader reader)
                           throws javax.xml.bind.JAXBException
        Specified by:
        unmarshal in interface javax.xml.bind.Unmarshaller
        Throws:
        javax.xml.bind.JAXBException

      • unmarshal

        public java.lang.Object unmarshal​(org.w3c.dom.Node node)
                           throws javax.xml.bind.JAXBException
        Specified by:
        unmarshal in interface javax.xml.bind.Unmarshaller
        Throws:
        javax.xml.bind.JAXBException

      • unmarshal

        public javax.xml.bind.JAXBElement unmarshal​(org.w3c.dom.Node node,
                                            java.lang.Class javaClass)
                                     throws javax.xml.bind.JAXBException
        Specified by:
        unmarshal in interface javax.xml.bind.Unmarshaller
        Throws:
        javax.xml.bind.JAXBException

      • unmarshal

        public java.lang.Object unmarshal​(javax.xml.transform.Source source)
                           throws javax.xml.bind.JAXBException
        Specified by:
        unmarshal in interface javax.xml.bind.Unmarshaller
        Throws:
        javax.xml.bind.JAXBException

      • unmarshal

        public javax.xml.bind.JAXBElement unmarshal​(javax.xml.transform.Source source,
                                            java.lang.Class javaClass)
                                     throws javax.xml.bind.JAXBException
        Specified by:
        unmarshal in interface javax.xml.bind.Unmarshaller
        Throws:
        javax.xml.bind.JAXBException

      • unmarshal

        public javax.xml.bind.JAXBElement unmarshal​(javax.xml.transform.Source source,
                                            java.lang.reflect.Type type)
                                     throws javax.xml.bind.JAXBException
        Throws:
        javax.xml.bind.JAXBException

      • unmarshal

        public javax.xml.bind.JAXBElement unmarshal​(javax.xml.transform.Source source,
                                            TypeMappingInfo type)
                                     throws javax.xml.bind.JAXBException
        Unmarshal the object based on the binding metadata associated with the TypeMappingInfo.
        Throws:
        javax.xml.bind.JAXBException

      • unmarshal

        public javax.xml.bind.JAXBElement unmarshal​(javax.xml.stream.XMLStreamReader streamReader,
                                            java.lang.Class javaClass)
                                     throws javax.xml.bind.JAXBException
        Specified by:
        unmarshal in interface javax.xml.bind.Unmarshaller
        Throws:
        javax.xml.bind.JAXBException

      • unmarshal

        public javax.xml.bind.JAXBElement unmarshal​(javax.xml.stream.XMLStreamReader streamReader,
                                            java.lang.reflect.Type type)
                                     throws javax.xml.bind.JAXBException
        Throws:
        javax.xml.bind.JAXBException

      • unmarshal

        public javax.xml.bind.JAXBElement unmarshal​(javax.xml.stream.XMLStreamReader streamReader,
                                            TypeMappingInfo type)
                                     throws javax.xml.bind.JAXBException
        Unmarshal the object based on the binding metadata associated with the TypeMappingInfo.
        Throws:
        javax.xml.bind.JAXBException

      • unmarshal

        public java.lang.Object unmarshal​(javax.xml.stream.XMLStreamReader streamReader)
                           throws javax.xml.bind.JAXBException
        Specified by:
        unmarshal in interface javax.xml.bind.Unmarshaller
        Throws:
        javax.xml.bind.JAXBException

      • unmarshal

        public javax.xml.bind.JAXBElement unmarshal​(javax.xml.stream.XMLEventReader eventReader,
                                            java.lang.Class javaClass)
                                     throws javax.xml.bind.JAXBException
        Specified by:
        unmarshal in interface javax.xml.bind.Unmarshaller
        Throws:
        javax.xml.bind.JAXBException

      • unmarshal

        public javax.xml.bind.JAXBElement unmarshal​(javax.xml.stream.XMLEventReader eventReader,
                                            java.lang.reflect.Type type)
                                     throws javax.xml.bind.JAXBException
        Throws:
        javax.xml.bind.JAXBException

      • unmarshal

        public javax.xml.bind.JAXBElement unmarshal​(javax.xml.stream.XMLEventReader eventReader,
                                            TypeMappingInfo type)
                                     throws javax.xml.bind.JAXBException
        Unmarshal the object based on the binding metadata associated with the TypeMappingInfo.
        Throws:
        javax.xml.bind.JAXBException

      • unmarshal

        public java.lang.Object unmarshal​(javax.xml.stream.XMLEventReader eventReader)
                           throws javax.xml.bind.JAXBException
        Specified by:
        unmarshal in interface javax.xml.bind.Unmarshaller
        Throws:
        javax.xml.bind.JAXBException

      • getUnmarshallerHandler

        public javax.xml.bind.UnmarshallerHandler getUnmarshallerHandler()
        Specified by:
        getUnmarshallerHandler in interface javax.xml.bind.Unmarshaller

      • setValidating

        public void setValidating​(boolean validate)
                   throws javax.xml.bind.JAXBException
        Specified by:
        setValidating in interface javax.xml.bind.Unmarshaller
        Throws:
        javax.xml.bind.JAXBException

      • isValidating

        public boolean isValidating()
                     throws javax.xml.bind.JAXBException
        Specified by:
        isValidating in interface javax.xml.bind.Unmarshaller
        Throws:
        javax.xml.bind.JAXBException

      • setEventHandler

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

      • getEventHandler

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

      • setProperty

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

      • 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 See Supported Properties.
        Specified by:
        getProperty in interface javax.xml.bind.Unmarshaller
        Throws:
        javax.xml.bind.PropertyException
        See Also:
        UnmarshallerProperties

      • getListener

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

      • setListener

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

      • getAdapter

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

      • setAdapter

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

      • setAdapter

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

      • setSchema

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

      • getSchema

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

      • getAttachmentUnmarshaller

        public javax.xml.bind.attachment.AttachmentUnmarshaller getAttachmentUnmarshaller()
        Specified by:
        getAttachmentUnmarshaller in interface javax.xml.bind.Unmarshaller

      • setAttachmentUnmarshaller

        public void setAttachmentUnmarshaller​(javax.xml.bind.attachment.AttachmentUnmarshaller unmarshaller)
        Specified by:
        setAttachmentUnmarshaller in interface javax.xml.bind.Unmarshaller

      • setUnmarshalCallbacks

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

      • getIDResolver

        public org.eclipse.persistence.oxm.IDResolver getIDResolver()
        Return this Unmarshaller's custom IDResolver.
        Returns:
        the custom IDResolver, or null if one has not been specified.
        Since:
        2.3.3
        See Also:
        IDResolver

      • setIDResolver

        public void setIDResolver​(org.eclipse.persistence.oxm.IDResolver idResolver)
        Set this Unmarshaller's custom IDResolver.
        Since:
        2.3.3
        See Also:
        IDResolver

      • 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