XMLUnmarshaller (EclipseLink 2.6.3, "build v20160428-59c81c5" API Reference)

java.lang.Object
- org.eclipse.persistence.internal.oxm.Unmarshaller<ABSTRACT_SESSION,CONTEXT,DESCRIPTOR,ID_RESOLVER,MEDIA_TYPE,ROOT,UNMARSHALLER_HANDLER,UNMARSHALLER_LISTENER>
- - org.eclipse.persistence.internal.oxm.XMLUnmarshaller<ABSTRACT_SESSION,CONTEXT,DESCRIPTOR,ID_RESOLVER,MEDIA_TYPE,ROOT,UNMARSHALLER_HANDLER,UNMARSHALLER_LISTENER>

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

XMLUnmarshaller
```
public class XMLUnmarshaller<ABSTRACT_SESSION extends CoreAbstractSession,CONTEXT extends Context,DESCRIPTOR extends Descriptor,ID_RESOLVER extends IDResolver,MEDIA_TYPE extends MediaType,ROOT extends Root,UNMARSHALLER_HANDLER extends UnmarshallerHandler,UNMARSHALLER_LISTENER extends Unmarshaller.Listener>
extends Unmarshaller<ABSTRACT_SESSION,CONTEXT,DESCRIPTOR,ID_RESOLVER,MEDIA_TYPE,ROOT,UNMARSHALLER_HANDLER,UNMARSHALLER_LISTENER>
implements java.lang.Cloneable
```
Class used to unmarshal XML & JSON to objects.
Create an XMLUnmarshaller from an XMLContext.
Code Sample
XMLContext context = new XMLContext("mySessionName"); XMLUnmarshaller unmarshaller = context.createUnmarshaller();
XML can be unmarshalled from the following inputs:
XML that can be unmarshalled is XML which has a root tag that corresponds to a default root element on an XMLDescriptor in the TopLink project associated with the XMLContext.
See Also: XMLContext










Nested Class Summary




Nested classes/interfaces inherited from class org.eclipse.persistence.internal.oxm.Unmarshaller
Unmarshaller.Listener








Field Summary

Fields 

Modifier and Type
Field and Description


static int
DTD_VALIDATION 


static int
NONVALIDATING 


static int
SCHEMA_VALIDATION 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


XMLUnmarshaller
clone() 


ROOT
createRoot()
INTERNAL



UnmarshalRecord
createRootUnmarshalRecord(java.lang.Class clazz)
INTERNAL



UnmarshalRecord
createUnmarshalRecord(DESCRIPTOR xmlDescriptor,
                     ABSTRACT_SESSION session)
INTERNAL



XMLAttachmentUnmarshaller
getAttachmentUnmarshaller() 


java.lang.String
getAttributePrefix()
Value that will be used to prefix attributes.



org.xml.sax.EntityResolver
getEntityResolver()
Get the EntityResolver set on this XMLUnmarshaller



org.xml.sax.ErrorHandler
getErrorHandler()
Get the ErrorHandler set on this XMLUnmarshaller



ID_RESOLVER
getIDResolver()
Return this Unmarshaller's custom IDResolver.



JsonTypeConfiguration
getJsonTypeConfiguration()
Returns json type configuration.



MEDIA_TYPE
getMediaType()
Get the MediaType for this xmlUnmarshaller.



NamespaceResolver
getNamespaceResolver()
Name of the NamespaceResolver to be used during unmarshal
 Ignored unmarshalling XML.



char
getNamespaceSeparator()
Get the namespace separator used during unmarshal operations.



java.util.Properties
getProperties()
Return a properties object for a given instance of the
 XMLUnmarshaller.



java.lang.Object
getProperty(java.lang.Object key)
Return the property for a given key, if one exists.



javax.xml.validation.Schema
getSchema() 


StrBuffer
getStringBuffer()
INTERNAL:
 This is the text handler during unmarshal operations.



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



java.lang.Object
getUnmarshalAttributeGroup()
INTERNAL:
 Returns the AttributeGroup or the name of the AttributeGroup to be used to
 unmarshal.



UNMARSHALLER_HANDLER
getUnmarshallerHandler() 


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



java.lang.String
getValueWrapper()
Name of the property to marshal/unmarshal as a wrapper on the text() mappings
 Ignored unmarshalling XML.



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



boolean
isApplicationJSON()
INTERNAL



boolean
isApplicationXML()
INTERNAL



boolean
isAutoDetectMediaType()
Return if this XMLUnmarshaller should try to automatically determine
 the MediaType of the document (instead of using the MediaType set
 by setMediaType)



boolean
isCaseInsensitive()
Return if this Unmarshaller should perform case insensitive unmarshalling.



boolean
isIncludeRoot()
Determine if the @XMLRootElement should be marshalled when present.



boolean
isResultAlwaysXMLRoot() 


boolean
isSecureProcessingDisabled() 


boolean
isWrapperAsCollectionName() 


void
setAttachmentUnmarshaller(XMLAttachmentUnmarshaller atu) 


void
setAttributePrefix(java.lang.String attributePrefix)
Value that will be used to prefix attributes.



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)



void
setCaseInsensitive(boolean caseInsensitive)
Set true to make this Unmarshaller perform case insensitive unmarshalling.



void
setDisableSecureProcessing(boolean disableSecureProcessing) 


void
setEntityResolver(org.xml.sax.EntityResolver entityResolver)
Set the EntityResolver on this XMLUnmarshaller



void
setErrorHandler(org.xml.sax.ErrorHandler errorHandler)
Set the ErrorHandler on this XMLUnmarshaller



void
setIDResolver(ID_RESOLVER idResolver)
Set this Unmarshaller's custom IDResolver.



void
setIncludeRoot(boolean includeRoot)
Determine if the @XMLRootElement should be marshalled when present.



void
setMediaType(MEDIA_TYPE mediaType)
Set the MediaType for this xmlUnmarshaller.



void
setNamespaceResolver(NamespaceResolver namespaceResolver)
Get the NamespaceResolver to be used during unmarshal
 Ignored unmarshalling XML.



void
setNamespaceSeparator(char namespaceSeparator)
Set the namespace separator used during unmarshal operations.



void
setResultAlwaysXMLRoot(boolean alwaysReturnRoot) 


void
setSchema(javax.xml.validation.Schema schema) 


void
setUnmappedContentHandlerClass(java.lang.Class aClass)
Set the class that will be instantiated to handled unmapped content
 Class must implement the org.eclipse.persistence.oxm.unmapped.UnmappedContentHandler interface



void
setUnmarshalAttributeGroup(java.lang.Object attributeGroup) 


void
setValueWrapper(java.lang.String valueWrapper)
Name of the property to marshal/unmarshal as a wrapper on the text() mappings
 Ignored unmarshalling XML.



void
setWarnOnUnmappedElement(boolean warnOnUnmappedElement)
INTERNAL:
 Set to true if a warning exception should be generated when an unmapped element is encountered, false otherwise.



void
setWrapperAsCollectionName(boolean wrapperAsCollectionName) 


void
setXMLContext(CONTEXT value)
Set the XMLContext used by this instance of XMLUnmarshaller.



boolean
shouldWarnOnUnmappedElement()
INTERNAL:
 Returns true if a warning exception should be generated when an unmapped element is encountered.



java.lang.Object
unmarshal(java.io.File file)
PUBLIC:
 Read and parse the XML document from the file and map the XML data into an object.



java.lang.Object
unmarshal(java.io.File file,
         java.lang.Class clazz)
PUBLIC:
 Read and parse the XML document from the file and map the XML data into an object.



java.lang.Object
unmarshal(org.xml.sax.InputSource inputSource)
PUBLIC:
 Read and parse the XML document from the inputSource and map the XML data into an object.



java.lang.Object
unmarshal(org.xml.sax.InputSource inputSource,
         java.lang.Class clazz)
PUBLIC:
 Read and parse the XML document from the inputSource and map the XML data into an object.



java.lang.Object
unmarshal(java.io.InputStream inputStream)
PUBLIC:
 Read and parse the XML document from the inputStream and map the XML data into an object.



java.lang.Object
unmarshal(java.io.InputStream inputStream,
         java.lang.Class clazz)
PUBLIC:
 Read and parse the XML document from the inputStream and map the XML data into an object.



java.lang.Object
unmarshal(org.w3c.dom.Node node)
PUBLIC:
 Map the XML node into an object.



java.lang.Object
unmarshal(org.w3c.dom.Node node,
         java.lang.Class clazz)
PUBLIC:
 Map the XML node into an object.



java.lang.Object
unmarshal(java.io.Reader reader)
PUBLIC:
 Read and parse the XML document from the reader and map the XML data into an object.



java.lang.Object
unmarshal(java.io.Reader reader,
         java.lang.Class clazz)
PUBLIC:
 Read and parse the XML document from the reader and map the XML data into an object.



java.lang.Object
unmarshal(javax.xml.transform.Source source)
PUBLIC:
 Read and parse the XML document from the source and map the XML data into an object.



java.lang.Object
unmarshal(javax.xml.transform.Source source,
         java.lang.Class clazz)
PUBLIC:
 Read and parse the XML document from the source and map the XML data into an object.



java.lang.Object
unmarshal(java.net.URL url)
PUBLIC:
 Read and parse the XML document from the url and map the XML data into an object.



java.lang.Object
unmarshal(java.net.URL url,
         java.lang.Class clazz)
PUBLIC:
 Read and parse the XML document from the url and map the XML data into an object.



java.lang.Object
unmarshal(org.xml.sax.XMLReader xmlReader,
         org.xml.sax.InputSource inputSource) 


java.lang.Object
unmarshal(org.xml.sax.XMLReader xmlReader,
         org.xml.sax.InputSource inputSource,
         java.lang.Class clazz) 






Methods inherited from class org.eclipse.persistence.internal.oxm.Unmarshaller
getContext, getUnmarshalListener, setUnmarshalListener





Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait














Field Detail





NONVALIDATING
public static final int NONVALIDATING

See Also:
Constant Field Values








SCHEMA_VALIDATION
public static final int SCHEMA_VALIDATION

See Also:
Constant Field Values








DTD_VALIDATION
public static final int DTD_VALIDATION

See Also:
Constant Field Values










Method Detail







setMediaType
public void setMediaType(MEDIA_TYPE 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 MEDIA_TYPE 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 Unmarshaller<ABSTRACT_SESSION extends CoreAbstractSession,CONTEXT extends Context,DESCRIPTOR extends Descriptor,ID_RESOLVER extends IDResolver,MEDIA_TYPE extends MediaType,ROOT extends Root,UNMARSHALLER_HANDLER extends UnmarshallerHandler,UNMARSHALLER_LISTENER extends Unmarshaller.Listener>
Returns:
MediaType
Since:
2.4








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









setXMLContext
public void setXMLContext(CONTEXT 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








getEntityResolver
public org.xml.sax.EntityResolver getEntityResolver()
Get the EntityResolver set on this XMLUnmarshaller

Returns:
the EntityResolver set on this XMLUnmarshaller








setEntityResolver
public void setEntityResolver(org.xml.sax.EntityResolver entityResolver)
Set the EntityResolver on this XMLUnmarshaller

Parameters:
entityResolver - the EntityResolver to set on this XMLUnmarshaller








getErrorHandler
public org.xml.sax.ErrorHandler getErrorHandler()
Get the ErrorHandler set on this XMLUnmarshaller

Specified by:
getErrorHandler in class Unmarshaller<ABSTRACT_SESSION extends CoreAbstractSession,CONTEXT extends Context,DESCRIPTOR extends Descriptor,ID_RESOLVER extends IDResolver,MEDIA_TYPE extends MediaType,ROOT extends Root,UNMARSHALLER_HANDLER extends UnmarshallerHandler,UNMARSHALLER_LISTENER extends Unmarshaller.Listener>
Returns:
the ErrorHandler set on this XMLUnmarshaller








setErrorHandler
public void setErrorHandler(org.xml.sax.ErrorHandler errorHandler)
Set the ErrorHandler on this XMLUnmarshaller

Parameters:
errorHandler - the ErrorHandler to set on this XMLUnmarshaller








getUnmappedContentHandlerClass
public java.lang.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 Unmarshaller<ABSTRACT_SESSION extends CoreAbstractSession,CONTEXT extends Context,DESCRIPTOR extends Descriptor,ID_RESOLVER extends IDResolver,MEDIA_TYPE extends MediaType,ROOT extends Root,UNMARSHALLER_HANDLER extends UnmarshallerHandler,UNMARSHALLER_LISTENER extends Unmarshaller.Listener>








setUnmappedContentHandlerClass
public void setUnmappedContentHandlerClass(java.lang.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 StrBuffer getStringBuffer()
INTERNAL:
 This is the text handler during unmarshal operations.

Specified by:
getStringBuffer in class Unmarshaller<ABSTRACT_SESSION extends CoreAbstractSession,CONTEXT extends Context,DESCRIPTOR extends Descriptor,ID_RESOLVER extends IDResolver,MEDIA_TYPE extends MediaType,ROOT extends Root,UNMARSHALLER_HANDLER extends UnmarshallerHandler,UNMARSHALLER_LISTENER extends Unmarshaller.Listener>








unmarshal
public java.lang.Object unmarshal(java.io.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 java.lang.Object unmarshal(java.io.File file,
                                  java.lang.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 java.lang.Object unmarshal(java.io.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 java.lang.Object unmarshal(java.io.InputStream inputStream,
                                  java.lang.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 java.lang.Object unmarshal(java.io.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 java.lang.Object unmarshal(java.io.Reader reader,
                                  java.lang.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 java.lang.Object unmarshal(java.net.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 java.lang.Object unmarshal(java.net.URL url,
                                  java.lang.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 java.lang.Object unmarshal(org.xml.sax.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 java.lang.Object unmarshal(org.xml.sax.InputSource inputSource,
                                  java.lang.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 java.lang.Object unmarshal(org.w3c.dom.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 java.lang.Object unmarshal(org.w3c.dom.Node node,
                                  java.lang.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 java.lang.Object unmarshal(javax.xml.transform.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 java.util.Properties getProperties()
Return a properties object for a given instance of the
 XMLUnmarshaller.

Returns:








getProperty
public java.lang.Object getProperty(java.lang.Object key)
Return the property for a given key, if one exists.

Specified by:
getProperty in class Unmarshaller<ABSTRACT_SESSION extends CoreAbstractSession,CONTEXT extends Context,DESCRIPTOR extends Descriptor,ID_RESOLVER extends IDResolver,MEDIA_TYPE extends MediaType,ROOT extends Root,UNMARSHALLER_HANDLER extends UnmarshallerHandler,UNMARSHALLER_LISTENER extends Unmarshaller.Listener>
Returns:








unmarshal
public java.lang.Object unmarshal(javax.xml.transform.Source source,
                                  java.lang.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








unmarshal
public java.lang.Object unmarshal(org.xml.sax.XMLReader xmlReader,
                                  org.xml.sax.InputSource inputSource)







unmarshal
public java.lang.Object unmarshal(org.xml.sax.XMLReader xmlReader,
                                  org.xml.sax.InputSource inputSource,
                                  java.lang.Class clazz)







getUnmarshallerHandler
public UNMARSHALLER_HANDLER getUnmarshallerHandler()

Specified by:
getUnmarshallerHandler in class Unmarshaller<ABSTRACT_SESSION extends CoreAbstractSession,CONTEXT extends Context,DESCRIPTOR extends Descriptor,ID_RESOLVER extends IDResolver,MEDIA_TYPE extends MediaType,ROOT extends Root,UNMARSHALLER_HANDLER extends UnmarshallerHandler,UNMARSHALLER_LISTENER extends Unmarshaller.Listener>








getAttachmentUnmarshaller
public XMLAttachmentUnmarshaller getAttachmentUnmarshaller()

Specified by:
getAttachmentUnmarshaller in class Unmarshaller<ABSTRACT_SESSION extends CoreAbstractSession,CONTEXT extends Context,DESCRIPTOR extends Descriptor,ID_RESOLVER extends IDResolver,MEDIA_TYPE extends MediaType,ROOT extends Root,UNMARSHALLER_HANDLER extends UnmarshallerHandler,UNMARSHALLER_LISTENER extends Unmarshaller.Listener>








setAttachmentUnmarshaller
public void setAttachmentUnmarshaller(XMLAttachmentUnmarshaller atu)







setResultAlwaysXMLRoot
public void setResultAlwaysXMLRoot(boolean alwaysReturnRoot)







isResultAlwaysXMLRoot
public boolean isResultAlwaysXMLRoot()

Specified by:
isResultAlwaysXMLRoot in class Unmarshaller<ABSTRACT_SESSION extends CoreAbstractSession,CONTEXT extends Context,DESCRIPTOR extends Descriptor,ID_RESOLVER extends IDResolver,MEDIA_TYPE extends MediaType,ROOT extends Root,UNMARSHALLER_HANDLER extends UnmarshallerHandler,UNMARSHALLER_LISTENER extends Unmarshaller.Listener>








setSchema
public void setSchema(javax.xml.validation.Schema schema)







getSchema
public javax.xml.validation.Schema getSchema()

Specified by:
getSchema in class Unmarshaller<ABSTRACT_SESSION extends CoreAbstractSession,CONTEXT extends Context,DESCRIPTOR extends Descriptor,ID_RESOLVER extends IDResolver,MEDIA_TYPE extends MediaType,ROOT extends Root,UNMARSHALLER_HANDLER extends UnmarshallerHandler,UNMARSHALLER_LISTENER extends Unmarshaller.Listener>








getAttributePrefix
public java.lang.String getAttributePrefix()
Value that will be used to prefix attributes.
 Ignored unmarshalling XML.

Specified by:
getAttributePrefix in class Unmarshaller<ABSTRACT_SESSION extends CoreAbstractSession,CONTEXT extends Context,DESCRIPTOR extends Descriptor,ID_RESOLVER extends IDResolver,MEDIA_TYPE extends MediaType,ROOT extends Root,UNMARSHALLER_HANDLER extends UnmarshallerHandler,UNMARSHALLER_LISTENER extends Unmarshaller.Listener>
Returns:
Since:
2.4








setAttributePrefix
public void setAttributePrefix(java.lang.String attributePrefix)
Value that will be used to prefix attributes.
 Ignored unmarshalling XML.

Since:
2.4








getValueWrapper
public java.lang.String getValueWrapper()
Name of the property to marshal/unmarshal as a wrapper on the text() mappings
 Ignored unmarshalling XML.

Specified by:
getValueWrapper in class Unmarshaller<ABSTRACT_SESSION extends CoreAbstractSession,CONTEXT extends Context,DESCRIPTOR extends Descriptor,ID_RESOLVER extends IDResolver,MEDIA_TYPE extends MediaType,ROOT extends Root,UNMARSHALLER_HANDLER extends UnmarshallerHandler,UNMARSHALLER_LISTENER extends Unmarshaller.Listener>
Since:
2.4








setValueWrapper
public void setValueWrapper(java.lang.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 Unmarshaller<ABSTRACT_SESSION extends CoreAbstractSession,CONTEXT extends Context,DESCRIPTOR extends Descriptor,ID_RESOLVER extends IDResolver,MEDIA_TYPE extends MediaType,ROOT extends Root,UNMARSHALLER_HANDLER extends UnmarshallerHandler,UNMARSHALLER_LISTENER extends Unmarshaller.Listener>
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 Unmarshaller<ABSTRACT_SESSION extends CoreAbstractSession,CONTEXT extends Context,DESCRIPTOR extends Descriptor,ID_RESOLVER extends IDResolver,MEDIA_TYPE extends MediaType,ROOT extends Root,UNMARSHALLER_HANDLER extends UnmarshallerHandler,UNMARSHALLER_LISTENER extends Unmarshaller.Listener>
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








isApplicationJSON
public boolean isApplicationJSON()
INTERNAL

Specified by:
isApplicationJSON in class Unmarshaller<ABSTRACT_SESSION extends CoreAbstractSession,CONTEXT extends Context,DESCRIPTOR extends Descriptor,ID_RESOLVER extends IDResolver,MEDIA_TYPE extends MediaType,ROOT extends Root,UNMARSHALLER_HANDLER extends UnmarshallerHandler,UNMARSHALLER_LISTENER extends Unmarshaller.Listener>
Returns:
true if the media type is application/json, else false.
Since:
EclipseLink 2.6.0








isApplicationXML
public boolean isApplicationXML()
INTERNAL

Specified by:
isApplicationXML in class Unmarshaller<ABSTRACT_SESSION extends CoreAbstractSession,CONTEXT extends Context,DESCRIPTOR extends Descriptor,ID_RESOLVER extends IDResolver,MEDIA_TYPE extends MediaType,ROOT extends Root,UNMARSHALLER_HANDLER extends UnmarshallerHandler,UNMARSHALLER_LISTENER extends Unmarshaller.Listener>
Returns:
true if the media type is application/xml, else false.
Since:
EclipseLink 2.6.0








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 Unmarshaller<ABSTRACT_SESSION extends CoreAbstractSession,CONTEXT extends Context,DESCRIPTOR extends Descriptor,ID_RESOLVER extends IDResolver,MEDIA_TYPE extends MediaType,ROOT extends Root,UNMARSHALLER_HANDLER extends UnmarshallerHandler,UNMARSHALLER_LISTENER extends Unmarshaller.Listener>








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)







isCaseInsensitive
public boolean isCaseInsensitive()
Return if this Unmarshaller should perform case insensitive unmarshalling.

Specified by:
isCaseInsensitive in class Unmarshaller<ABSTRACT_SESSION extends CoreAbstractSession,CONTEXT extends Context,DESCRIPTOR extends Descriptor,ID_RESOLVER extends IDResolver,MEDIA_TYPE extends MediaType,ROOT extends Root,UNMARSHALLER_HANDLER extends UnmarshallerHandler,UNMARSHALLER_LISTENER extends Unmarshaller.Listener>








setCaseInsensitive
public void setCaseInsensitive(boolean caseInsensitive)
Set true to make this Unmarshaller perform case insensitive unmarshalling.







getNamespaceResolver
public NamespaceResolver getNamespaceResolver()
Name of the NamespaceResolver to be used during unmarshal
 Ignored unmarshalling XML.

Specified by:
getNamespaceResolver in class Unmarshaller<ABSTRACT_SESSION extends CoreAbstractSession,CONTEXT extends Context,DESCRIPTOR extends Descriptor,ID_RESOLVER extends IDResolver,MEDIA_TYPE extends MediaType,ROOT extends Root,UNMARSHALLER_HANDLER extends UnmarshallerHandler,UNMARSHALLER_LISTENER extends Unmarshaller.Listener>
Since:
2.4








setNamespaceResolver
public void setNamespaceResolver(NamespaceResolver namespaceResolver)
Get the NamespaceResolver to be used during unmarshal
 Ignored unmarshalling XML.

Since:
2.4








isWrapperAsCollectionName
public boolean isWrapperAsCollectionName()

Specified by:
isWrapperAsCollectionName in class Unmarshaller<ABSTRACT_SESSION extends CoreAbstractSession,CONTEXT extends Context,DESCRIPTOR extends Descriptor,ID_RESOLVER extends IDResolver,MEDIA_TYPE extends MediaType,ROOT extends Root,UNMARSHALLER_HANDLER extends UnmarshallerHandler,UNMARSHALLER_LISTENER extends Unmarshaller.Listener>
Since:
2.4.2








setWrapperAsCollectionName
public void setWrapperAsCollectionName(boolean wrapperAsCollectionName)

Since:
2.4.2








clone
public XMLUnmarshaller clone()

Overrides:
clone in class java.lang.Object








getIDResolver
public ID_RESOLVER getIDResolver()
Return this Unmarshaller's custom IDResolver.

Specified by:
getIDResolver in class Unmarshaller<ABSTRACT_SESSION extends CoreAbstractSession,CONTEXT extends Context,DESCRIPTOR extends Descriptor,ID_RESOLVER extends IDResolver,MEDIA_TYPE extends MediaType,ROOT extends Root,UNMARSHALLER_HANDLER extends UnmarshallerHandler,UNMARSHALLER_LISTENER extends Unmarshaller.Listener>
Returns:
the custom IDResolver, or null if one has not been specified.
Since:
2.3.3
See Also:
IDResolver










setIDResolver
public void setIDResolver(ID_RESOLVER idResolver)
Set this Unmarshaller's custom IDResolver.

Specified by:
setIDResolver in class Unmarshaller<ABSTRACT_SESSION extends CoreAbstractSession,CONTEXT extends Context,DESCRIPTOR extends Descriptor,ID_RESOLVER extends IDResolver,MEDIA_TYPE extends MediaType,ROOT extends Root,UNMARSHALLER_HANDLER extends UnmarshallerHandler,UNMARSHALLER_LISTENER extends Unmarshaller.Listener>
Since:
2.3.3
See Also:
IDResolver








createRoot
public ROOT createRoot()
INTERNAL

Specified by:
createRoot in class Unmarshaller<ABSTRACT_SESSION extends CoreAbstractSession,CONTEXT extends Context,DESCRIPTOR extends Descriptor,ID_RESOLVER extends IDResolver,MEDIA_TYPE extends MediaType,ROOT extends Root,UNMARSHALLER_HANDLER extends UnmarshallerHandler,UNMARSHALLER_LISTENER extends Unmarshaller.Listener>
Since:
2.5.0








createRootUnmarshalRecord
public UnmarshalRecord createRootUnmarshalRecord(java.lang.Class clazz)
INTERNAL

Specified by:
createRootUnmarshalRecord in class Unmarshaller<ABSTRACT_SESSION extends CoreAbstractSession,CONTEXT extends Context,DESCRIPTOR extends Descriptor,ID_RESOLVER extends IDResolver,MEDIA_TYPE extends MediaType,ROOT extends Root,UNMARSHALLER_HANDLER extends UnmarshallerHandler,UNMARSHALLER_LISTENER extends Unmarshaller.Listener>
Since:
2.5.0










createUnmarshalRecord
public UnmarshalRecord createUnmarshalRecord(DESCRIPTOR xmlDescriptor,
                                             ABSTRACT_SESSION session)
INTERNAL

Specified by:
createUnmarshalRecord in class Unmarshaller<ABSTRACT_SESSION extends CoreAbstractSession,CONTEXT extends Context,DESCRIPTOR extends Descriptor,ID_RESOLVER extends IDResolver,MEDIA_TYPE extends MediaType,ROOT extends Root,UNMARSHALLER_HANDLER extends UnmarshallerHandler,UNMARSHALLER_LISTENER extends Unmarshaller.Listener>
Since:
2.5.0








getUnmarshalAttributeGroup
public java.lang.Object getUnmarshalAttributeGroup()
INTERNAL:
 Returns the AttributeGroup or the name of the AttributeGroup to be used to
 unmarshal.

Specified by:
getUnmarshalAttributeGroup in class Unmarshaller<ABSTRACT_SESSION extends CoreAbstractSession,CONTEXT extends Context,DESCRIPTOR extends Descriptor,ID_RESOLVER extends IDResolver,MEDIA_TYPE extends MediaType,ROOT extends Root,UNMARSHALLER_HANDLER extends UnmarshallerHandler,UNMARSHALLER_LISTENER extends Unmarshaller.Listener>








setUnmarshalAttributeGroup
public void setUnmarshalAttributeGroup(java.lang.Object attributeGroup)







shouldWarnOnUnmappedElement
public boolean shouldWarnOnUnmappedElement()
INTERNAL:
 Returns true if a warning exception should be generated when an unmapped element is encountered.

Specified by:
shouldWarnOnUnmappedElement in class Unmarshaller<ABSTRACT_SESSION extends CoreAbstractSession,CONTEXT extends Context,DESCRIPTOR extends Descriptor,ID_RESOLVER extends IDResolver,MEDIA_TYPE extends MediaType,ROOT extends Root,UNMARSHALLER_HANDLER extends UnmarshallerHandler,UNMARSHALLER_LISTENER extends Unmarshaller.Listener>
Since:
2.6.0








setWarnOnUnmappedElement
public void setWarnOnUnmappedElement(boolean warnOnUnmappedElement)
INTERNAL:
 Set to true if a warning exception should be generated when an unmapped element is encountered, false otherwise.

Since:
2.6.0








getJsonTypeConfiguration
public JsonTypeConfiguration getJsonTypeConfiguration()
Returns json type configuration.

Specified by:
getJsonTypeConfiguration in class Unmarshaller<ABSTRACT_SESSION extends CoreAbstractSession,CONTEXT extends Context,DESCRIPTOR extends Descriptor,ID_RESOLVER extends IDResolver,MEDIA_TYPE extends MediaType,ROOT extends Root,UNMARSHALLER_HANDLER extends UnmarshallerHandler,UNMARSHALLER_LISTENER extends Unmarshaller.Listener>
Returns:
json type configuration
Since:
2.6.0








isSecureProcessingDisabled
public final boolean isSecureProcessingDisabled()







setDisableSecureProcessing
public final void setDisableSecureProcessing(boolean disableSecureProcessing)

Modifier and Type	Field and Description
`static int`	`DTD_VALIDATION`
`static int`	`NONVALIDATING`
`static int`	`SCHEMA_VALIDATION`

Modifier and Type	Method and Description
`XMLUnmarshaller`	`clone()`
`ROOT`	`createRoot()` INTERNAL
`UnmarshalRecord`	`createRootUnmarshalRecord(java.lang.Class clazz)` INTERNAL
`UnmarshalRecord`	`createUnmarshalRecord(DESCRIPTOR xmlDescriptor, ABSTRACT_SESSION session)` INTERNAL
`XMLAttachmentUnmarshaller`	`getAttachmentUnmarshaller()`
`java.lang.String`	`getAttributePrefix()` Value that will be used to prefix attributes.
`org.xml.sax.EntityResolver`	`getEntityResolver()` Get the EntityResolver set on this XMLUnmarshaller
`org.xml.sax.ErrorHandler`	`getErrorHandler()` Get the ErrorHandler set on this XMLUnmarshaller
`ID_RESOLVER`	`getIDResolver()` Return this Unmarshaller's custom IDResolver.
`JsonTypeConfiguration`	`getJsonTypeConfiguration()` Returns json type configuration.
`MEDIA_TYPE`	`getMediaType()` Get the MediaType for this xmlUnmarshaller.
`NamespaceResolver`	`getNamespaceResolver()` Name of the NamespaceResolver to be used during unmarshal Ignored unmarshalling XML.
`char`	`getNamespaceSeparator()` Get the namespace separator used during unmarshal operations.
`java.util.Properties`	`getProperties()` Return a properties object for a given instance of the XMLUnmarshaller.
`java.lang.Object`	`getProperty(java.lang.Object key)` Return the property for a given key, if one exists.
`javax.xml.validation.Schema`	`getSchema()`
`StrBuffer`	`getStringBuffer()` INTERNAL: This is the text handler during unmarshal operations.
`java.lang.Class`	`getUnmappedContentHandlerClass()` Get the class that will be instantiated to handled unmapped content Class must implement the org.eclipse.persistence.oxm.unmapped.UnmappedContentHandler interface
`java.lang.Object`	`getUnmarshalAttributeGroup()` INTERNAL: Returns the AttributeGroup or the name of the AttributeGroup to be used to unmarshal.
`UNMARSHALLER_HANDLER`	`getUnmarshallerHandler()`
`int`	`getValidationMode()` Get the validation mode set on this XMLUnmarshaller By default, the unmarshaller is set to be NONVALIDATING
`java.lang.String`	`getValueWrapper()` Name of the property to marshal/unmarshal as a wrapper on the text() mappings Ignored unmarshalling XML.
`CONTEXT`	`getXMLContext()` Return the instance of XMLContext that was used to create this instance of XMLUnmarshaller.
`boolean`	`isApplicationJSON()` INTERNAL
`boolean`	`isApplicationXML()` INTERNAL
`boolean`	`isAutoDetectMediaType()` Return if this XMLUnmarshaller should try to automatically determine the MediaType of the document (instead of using the MediaType set by setMediaType)
`boolean`	`isCaseInsensitive()` Return if this Unmarshaller should perform case insensitive unmarshalling.
`boolean`	`isIncludeRoot()` Determine if the @XMLRootElement should be marshalled when present.
`boolean`	`isResultAlwaysXMLRoot()`
`boolean`	`isSecureProcessingDisabled()`
`boolean`	`isWrapperAsCollectionName()`
`void`	`setAttachmentUnmarshaller(XMLAttachmentUnmarshaller atu)`
`void`	`setAttributePrefix(java.lang.String attributePrefix)` Value that will be used to prefix attributes.
`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)
`void`	`setCaseInsensitive(boolean caseInsensitive)` Set true to make this Unmarshaller perform case insensitive unmarshalling.
`void`	`setDisableSecureProcessing(boolean disableSecureProcessing)`
`void`	`setEntityResolver(org.xml.sax.EntityResolver entityResolver)` Set the EntityResolver on this XMLUnmarshaller
`void`	`setErrorHandler(org.xml.sax.ErrorHandler errorHandler)` Set the ErrorHandler on this XMLUnmarshaller
`void`	`setIDResolver(ID_RESOLVER idResolver)` Set this Unmarshaller's custom IDResolver.
`void`	`setIncludeRoot(boolean includeRoot)` Determine if the @XMLRootElement should be marshalled when present.
`void`	`setMediaType(MEDIA_TYPE mediaType)` Set the MediaType for this xmlUnmarshaller.
`void`	`setNamespaceResolver(NamespaceResolver namespaceResolver)` Get the NamespaceResolver to be used during unmarshal Ignored unmarshalling XML.
`void`	`setNamespaceSeparator(char namespaceSeparator)` Set the namespace separator used during unmarshal operations.
`void`	`setResultAlwaysXMLRoot(boolean alwaysReturnRoot)`
`void`	`setSchema(javax.xml.validation.Schema schema)`
`void`	`setUnmappedContentHandlerClass(java.lang.Class aClass)` Set the class that will be instantiated to handled unmapped content Class must implement the org.eclipse.persistence.oxm.unmapped.UnmappedContentHandler interface
`void`	`setUnmarshalAttributeGroup(java.lang.Object attributeGroup)`
`void`	`setValueWrapper(java.lang.String valueWrapper)` Name of the property to marshal/unmarshal as a wrapper on the text() mappings Ignored unmarshalling XML.
`void`	`setWarnOnUnmappedElement(boolean warnOnUnmappedElement)` INTERNAL: Set to true if a warning exception should be generated when an unmapped element is encountered, false otherwise.
`void`	`setWrapperAsCollectionName(boolean wrapperAsCollectionName)`
`void`	`setXMLContext(CONTEXT value)` Set the XMLContext used by this instance of XMLUnmarshaller.
`boolean`	`shouldWarnOnUnmappedElement()` INTERNAL: Returns true if a warning exception should be generated when an unmapped element is encountered.
`java.lang.Object`	`unmarshal(java.io.File file)` PUBLIC: Read and parse the XML document from the file and map the XML data into an object.
`java.lang.Object`	`unmarshal(java.io.File file, java.lang.Class clazz)` PUBLIC: Read and parse the XML document from the file and map the XML data into an object.
`java.lang.Object`	`unmarshal(org.xml.sax.InputSource inputSource)` PUBLIC: Read and parse the XML document from the inputSource and map the XML data into an object.
`java.lang.Object`	`unmarshal(org.xml.sax.InputSource inputSource, java.lang.Class clazz)` PUBLIC: Read and parse the XML document from the inputSource and map the XML data into an object.
`java.lang.Object`	`unmarshal(java.io.InputStream inputStream)` PUBLIC: Read and parse the XML document from the inputStream and map the XML data into an object.
`java.lang.Object`	`unmarshal(java.io.InputStream inputStream, java.lang.Class clazz)` PUBLIC: Read and parse the XML document from the inputStream and map the XML data into an object.
`java.lang.Object`	`unmarshal(org.w3c.dom.Node node)` PUBLIC: Map the XML node into an object.
`java.lang.Object`	`unmarshal(org.w3c.dom.Node node, java.lang.Class clazz)` PUBLIC: Map the XML node into an object.
`java.lang.Object`	`unmarshal(java.io.Reader reader)` PUBLIC: Read and parse the XML document from the reader and map the XML data into an object.
`java.lang.Object`	`unmarshal(java.io.Reader reader, java.lang.Class clazz)` PUBLIC: Read and parse the XML document from the reader and map the XML data into an object.
`java.lang.Object`	`unmarshal(javax.xml.transform.Source source)` PUBLIC: Read and parse the XML document from the source and map the XML data into an object.
`java.lang.Object`	`unmarshal(javax.xml.transform.Source source, java.lang.Class clazz)` PUBLIC: Read and parse the XML document from the source and map the XML data into an object.
`java.lang.Object`	`unmarshal(java.net.URL url)` PUBLIC: Read and parse the XML document from the url and map the XML data into an object.
`java.lang.Object`	`unmarshal(java.net.URL url, java.lang.Class clazz)` PUBLIC: Read and parse the XML document from the url and map the XML data into an object.
`java.lang.Object`	`unmarshal(org.xml.sax.XMLReader xmlReader, org.xml.sax.InputSource inputSource)`
`java.lang.Object`	`unmarshal(org.xml.sax.XMLReader xmlReader, org.xml.sax.InputSource inputSource, java.lang.Class clazz)`