org.eclipse.persistence.oxm

Class XMLUnmarshaller

    • Method Detail

      • setMediaType

        public void setMediaType(MediaType mediaType)
        Set the MediaType for this xmlUnmarshaller. See org.eclipse.persistence.oxm.MediaType for the media types supported by EclipseLink MOXy
        Parameters:
        mediaType -
        Since:
        2.4
      • getMediaType

        public MediaType getMediaType()
        Get the MediaType for this xmlUnmarshaller. See org.eclipse.persistence.oxm.MediaType for the media types supported by EclipseLink MOXy If not set the default is MediaType.APPLICATION_XML
        Specified by:
        getMediaType in class org.eclipse.persistence.internal.oxm.Unmarshaller<org.eclipse.persistence.internal.sessions.AbstractSession,XMLContext,XMLDescriptor,IDResolver,MediaType,XMLRoot,XMLUnmarshallerHandler>
        Returns:
        MediaType
        Since:
        2.4
      • 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
      • 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
      • 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
        Specified by:
        getUnmappedContentHandlerClass in class org.eclipse.persistence.internal.oxm.Unmarshaller<org.eclipse.persistence.internal.sessions.AbstractSession,XMLContext,XMLDescriptor,IDResolver,MediaType,XMLRoot,XMLUnmarshallerHandler>
      • 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.
        Specified by:
        getStringBuffer in class org.eclipse.persistence.internal.oxm.Unmarshaller<org.eclipse.persistence.internal.sessions.AbstractSession,XMLContext,XMLDescriptor,IDResolver,MediaType,XMLRoot,XMLUnmarshallerHandler>
      • 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:
      • 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)
      • setSchema

        public void setSchema(Schema schema)
      • setAttributePrefix

        public void setAttributePrefix(String attributePrefix)
        Value that will be used to prefix attributes. Ignored unmarshalling XML.
        Since:
        2.4
      • getValueWrapper

        public String getValueWrapper()
        Name of the property to marshal/unmarshal as a wrapper on the text() mappings Ignored unmarshalling XML.
        Specified by:
        getValueWrapper in class org.eclipse.persistence.internal.oxm.Unmarshaller<org.eclipse.persistence.internal.sessions.AbstractSession,XMLContext,XMLDescriptor,IDResolver,MediaType,XMLRoot,XMLUnmarshallerHandler>
        Since:
        2.4
      • setValueWrapper

        public void setValueWrapper(String valueWrapper)
        Name of the property to marshal/unmarshal as a wrapper on the text() mappings Ignored unmarshalling XML.
        Since:
        2.4
      • getNamespaceSeparator

        public char getNamespaceSeparator()
        Get the namespace separator used during unmarshal operations. If mediaType is application/json '.' is the default Ignored unmarshalling XML.
        Specified by:
        getNamespaceSeparator in class org.eclipse.persistence.internal.oxm.Unmarshaller<org.eclipse.persistence.internal.sessions.AbstractSession,XMLContext,XMLDescriptor,IDResolver,MediaType,XMLRoot,XMLUnmarshallerHandler>
        Since:
        2.4
      • setNamespaceSeparator

        public void setNamespaceSeparator(char namespaceSeparator)
        Set the namespace separator used during unmarshal operations. If mediaType is application/json '.' is the default Ignored unmarshalling XML.
        Since:
        2.4
      • isIncludeRoot

        public boolean isIncludeRoot()
        Determine if the @XMLRootElement should be marshalled when present. Ignored unmarshalling XML.
        Specified by:
        isIncludeRoot in class org.eclipse.persistence.internal.oxm.Unmarshaller<org.eclipse.persistence.internal.sessions.AbstractSession,XMLContext,XMLDescriptor,IDResolver,MediaType,XMLRoot,XMLUnmarshallerHandler>
        Returns:
        Since:
        2.4
      • setIncludeRoot

        public void setIncludeRoot(boolean includeRoot)
        Determine if the @XMLRootElement should be marshalled when present. Ignored unmarshalling XML.
        Since:
        2.4
      • isAutoDetectMediaType

        public boolean isAutoDetectMediaType()
        Return if this XMLUnmarshaller should try to automatically determine the MediaType of the document (instead of using the MediaType set by setMediaType)
        Specified by:
        isAutoDetectMediaType in class org.eclipse.persistence.internal.oxm.Unmarshaller<org.eclipse.persistence.internal.sessions.AbstractSession,XMLContext,XMLDescriptor,IDResolver,MediaType,XMLRoot,XMLUnmarshallerHandler>
      • setAutoDetectMediaType

        public void setAutoDetectMediaType(boolean autoDetectMediaType)
        Set if this XMLUnmarshaller should try to automatically determine the MediaType of the document (instead of using the MediaType set by setMediaType)
      • setNamespaceResolver

        public void setNamespaceResolver(NamespaceResolver namespaceResolver)
        Get the NamespaceResolver to be used during unmarshal Ignored unmarshalling XML.
        Since:
        2.4
      • setWrapperAsCollectionName

        public void setWrapperAsCollectionName(boolean wrapperAsCollectionName)
        Since:
        2.4.2
      • createRootUnmarshalRecord

        public org.eclipse.persistence.internal.oxm.record.UnmarshalRecord createRootUnmarshalRecord(Class clazz)
        INTERNAL
        Specified by:
        createRootUnmarshalRecord in class org.eclipse.persistence.internal.oxm.Unmarshaller<org.eclipse.persistence.internal.sessions.AbstractSession,XMLContext,XMLDescriptor,IDResolver,MediaType,XMLRoot,XMLUnmarshallerHandler>
        Since:
        2.5.0
      • createUnmarshalRecord

        public org.eclipse.persistence.internal.oxm.record.UnmarshalRecord createUnmarshalRecord(XMLDescriptor xmlDescriptor,
                                                                                        org.eclipse.persistence.internal.sessions.AbstractSession session)
        INTERNAL
        Specified by:
        createUnmarshalRecord in class org.eclipse.persistence.internal.oxm.Unmarshaller<org.eclipse.persistence.internal.sessions.AbstractSession,XMLContext,XMLDescriptor,IDResolver,MediaType,XMLRoot,XMLUnmarshallerHandler>
        Since:
        2.5.0
      • getUnmarshalAttributeGroup

        public Object getUnmarshalAttributeGroup()
        INTERNAL: Returns the AttributeGroup or the name of the AttributeGroup to be used to unmarshal.
        Specified by:
        getUnmarshalAttributeGroup in class org.eclipse.persistence.internal.oxm.Unmarshaller<org.eclipse.persistence.internal.sessions.AbstractSession,XMLContext,XMLDescriptor,IDResolver,MediaType,XMLRoot,XMLUnmarshallerHandler>
      • setUnmarshalAttributeGroup

        public void setUnmarshalAttributeGroup(Object attributeGroup)