org.eclipse.persistence.oxm

Class XMLUnmarshaller

    • Method Detail

      • getXMLContext

        public XMLContext getXMLContext()
        Return the instance of XMLContext that was used to create this instance of XMLUnmarshaller.
      • setXMLContext

        public void setXMLContext(XMLContext value)
        Set the XMLContext used by this instance of XMLUnmarshaller.
      • getValidationMode

        public int getValidationMode()
        Get the validation mode set on this XMLUnmarshaller By default, the unmarshaller is set to be NONVALIDATING
        Returns:
        the validation mode
      • resolveReferences

        public void resolveReferences(org.eclipse.persistence.internal.sessions.AbstractSession unitOfWork)
        INTERNAL
        Parameters:
        unitOfWork -
      • setValidationMode

        public void setValidationMode(int validationMode)
        Set the validation mode. This method sets the validation mode of the parser to one of the 3 types: NONVALIDATING, DTD_VALIDATION and SCHEMA_VALIDATION. By default, the unmarshaller is set to be NONVALIDATING
        Parameters:
        validationMode - sets the type of the validation mode to be used
      • getEntityResolver

        public EntityResolver getEntityResolver()
        Get the EntityResolver set on this XMLUnmarshaller
        Returns:
        the EntityResolver set on this XMLUnmarshaller
      • setEntityResolver

        public void setEntityResolver(EntityResolver entityResolver)
        Set the EntityResolver on this XMLUnmarshaller
        Parameters:
        entityResolver - the EntityResolver to set on this XMLUnmarshaller
      • getErrorHandler

        public ErrorHandler getErrorHandler()
        Get the ErrorHandler set on this XMLUnmarshaller
        Returns:
        the ErrorHandler set on this XMLUnmarshaller
      • setErrorHandler

        public void setErrorHandler(ErrorHandler errorHandler)
        Set the ErrorHandler on this XMLUnmarshaller
        Parameters:
        errorHandler - the ErrorHandler to set on this XMLUnmarshaller
      • getUnmappedContentHandlerClass

        public Class getUnmappedContentHandlerClass()
        Get the class that will be instantiated to handled unmapped content Class must implement the org.eclipse.persistence.oxm.unmapped.UnmappedContentHandler interface
      • setUnmappedContentHandlerClass

        public void setUnmappedContentHandlerClass(Class aClass)
        Set the class that will be instantiated to handled unmapped content Class must implement the org.eclipse.persistence.oxm.unmapped.UnmappedContentHandler interface
        Parameters:
        aClass -
      • getStringBuffer

        public org.eclipse.persistence.internal.oxm.StrBuffer getStringBuffer()
        INTERNAL: This is the text handler during unmarshal operations.
      • unmarshal

        public Object unmarshal(File file)
                         throws XMLMarshalException
        PUBLIC: Read and parse the XML document from the file and map the XML data into an object. The file must contain a valid XML document, and be mapped by a project used to create the XMLContext. The type of object returned will be based on the root element of the XML document.
        Parameters:
        file - The file to unmarshal from
        Returns:
        the object which resulted from unmarshalling the given file
        Throws:
        XMLMarshalException - if an error occurred during unmarshalling
      • unmarshal

        public Object unmarshal(File file,
                       Class clazz)
                         throws XMLMarshalException
        PUBLIC: Read and parse the XML document from the file and map the XML data into an object. The file must contain a valid XML document, and be mapped by a project used to create the XMLContext.
        Parameters:
        file - The file to unmarshal from
        clazz - The type of object to return.
        Returns:
        the object which resulted from unmarshalling the given file
        Throws:
        XMLMarshalException - if an error occurred during unmarshalling
      • unmarshal

        public Object unmarshal(InputStream inputStream)
                         throws XMLMarshalException
        PUBLIC: Read and parse the XML document from the inputStream and map the XML data into an object. The inputStream must contain a valid XML document, and be mapped by a project used to create the XMLContext. The type of object returned will be based on the root element of the XML document.
        Parameters:
        inputStream - The inputStream to unmarshal from
        Returns:
        the object which resulted from unmarshalling the given inputStream
        Throws:
        XMLMarshalException - if an error occurred during unmarshalling
      • unmarshal

        public Object unmarshal(InputStream inputStream,
                       Class clazz)
                         throws XMLMarshalException
        PUBLIC: Read and parse the XML document from the inputStream and map the XML data into an object. The file must contain a valid XML document, and be mapped by a project used to create the XMLContext.
        Parameters:
        inputStream - The inputStream to unmarshal from
        clazz - The type of object to return.
        Returns:
        the object which resulted from unmarshalling the given inputStream
        Throws:
        XMLMarshalException - if an error occurred during unmarshalling
      • unmarshal

        public Object unmarshal(Reader reader)
                         throws XMLMarshalException
        PUBLIC: Read and parse the XML document from the reader and map the XML data into an object. The reader must contain a valid XML document, and be mapped by a project used to create the XMLContext. The type of object returned will be based on the root element of the XML document.
        Parameters:
        reader - The reader to unmarshal from
        Returns:
        the object which resulted from unmarshalling the given reader
        Throws:
        XMLMarshalException - if an error occurred during unmarshalling
      • unmarshal

        public Object unmarshal(Reader reader,
                       Class clazz)
                         throws XMLMarshalException
        PUBLIC: Read and parse the XML document from the reader and map the XML data into an object. The file must contain a valid XML document, and be mapped by a project used to create the XMLContext.
        Parameters:
        reader - The reader to unmarshal from
        clazz - The type of object to return.
        Returns:
        the object which resulted from unmarshalling the given reader
        Throws:
        XMLMarshalException - if an error occurred during unmarshalling
      • unmarshal

        public Object unmarshal(URL url)
                         throws XMLMarshalException
        PUBLIC: Read and parse the XML document from the url and map the XML data into an object. The url must reference a valid XML document, and be mapped by a project used to create the XMLContext. The type of object returned will be based on the root element of the XML document.
        Parameters:
        url - The url to unmarshal from
        Returns:
        the object which resulted from unmarshalling the given url
        Throws:
        XMLMarshalException - if an error occurred during unmarshalling
      • unmarshal

        public Object unmarshal(URL url,
                       Class clazz)
                         throws XMLMarshalException
        PUBLIC: Read and parse the XML document from the url and map the XML data into an object. The url must reference a valid XML document, and be mapped by a project used to create the XMLContext.
        Parameters:
        url - The url to unmarshal from
        clazz - The type of object to return.
        Returns:
        the object which resulted from unmarshalling the given url
        Throws:
        XMLMarshalException - if an error occurred during unmarshalling
      • unmarshal

        public Object unmarshal(InputSource inputSource)
                         throws XMLMarshalException
        PUBLIC: Read and parse the XML document from the inputSource and map the XML data into an object. The inputSource must contain a valid XML document, and be mapped by a project used to create the XMLContext. The type of object returned will be based on the root element of the XML document.
        Parameters:
        inputSource - The inputSource to unmarshal from
        Returns:
        the object which resulted from unmarshalling the given inputSource
        Throws:
        XMLMarshalException - if an error occurred during unmarshalling
      • unmarshal

        public Object unmarshal(InputSource inputSource,
                       Class clazz)
                         throws XMLMarshalException
        PUBLIC: Read and parse the XML document from the inputSource and map the XML data into an object. The inputSource must contain a valid XML document, and be mapped by a project used to create the XMLContext.
        Parameters:
        inputSource - The inputSource to unmarshal from
        clazz - The type of object to return.
        Returns:
        the object which resulted from unmarshalling the given inputSource
        Throws:
        XMLMarshalException - if an error occurred during unmarshalling
      • unmarshal

        public Object unmarshal(Node node)
                         throws XMLMarshalException
        PUBLIC: Map the XML node into an object. The node must be a valid XML document, and be mapped by a project used to create the XMLContext.
        Parameters:
        node - The node to unmarshal from
        Returns:
        the object which resulted from unmarshalling the given node
        Throws:
        XMLMarshalException - if an error occurred during unmarshalling
      • unmarshal

        public Object unmarshal(Node node,
                       Class clazz)
                         throws XMLMarshalException
        PUBLIC: Map the XML node into an object. The node must be a valid XML document, and be mapped by a project used to create the XMLContext.
        Parameters:
        node - The node to unmarshal from
        clazz - The type of object to return.
        Returns:
        the object which resulted from unmarshalling the given node
        Throws:
        XMLMarshalException - if an error occurred during unmarshalling
      • unmarshal

        public Object unmarshal(Source source)
                         throws XMLMarshalException
        PUBLIC: Read and parse the XML document from the source and map the XML data into an object. The source must contain a valid XML document, and be mapped by a project used to create the XMLContext. The type of object returned will be based on the root element of the XML document.
        Parameters:
        source - The source to unmarshal from
        Returns:
        the object which resulted from unmarshalling the given source
        Throws:
        XMLMarshalException - if an error occurred during unmarshalling
      • getProperties

        public Properties getProperties()
        Return a properties object for a given instance of the XMLUnmarshaller.
        Returns:
      • getProperty

        public Object getProperty(Object key)
        Return the property for a given key, if one exists.
        Returns:
      • unmarshal

        public Object unmarshal(Source source,
                       Class clazz)
                         throws XMLMarshalException
        PUBLIC: Read and parse the XML document from the source and map the XML data into an object. The source must contain a valid XML document, and be mapped by a project used to create the XMLContext.
        Parameters:
        source - The inputSource to unmarshal from
        clazz - The type of object to return.
        Returns:
        the object which resulted from unmarshalling the given source
        Throws:
        XMLMarshalException - if an error occurred during unmarshalling
      • setResultAlwaysXMLRoot

        public void setResultAlwaysXMLRoot(boolean alwaysReturnRoot)
      • isResultAlwaysXMLRoot

        public boolean isResultAlwaysXMLRoot()
      • setSchema

        public void setSchema(Schema schema)
      • getSchema

        public Schema getSchema()