org.eclipse.persistence.oxm
Class XMLUnmarshaller

java.lang.Object
  org.eclipse.persistence.oxm.XMLUnmarshaller

All Implemented Interfaces:

java.lang.Cloneable

public class XMLUnmarshaller
extends java.lang.Object
implements java.lang.Cloneable

Class used to unmarshal XML 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:

• java.io.File
• java.io.InputStream
• java.io.Reader
• java.net.URL
• javax.xml.transform.Source
• org.w3c.dom.Node
• org.xml.sax.InputSource

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

Field Summary

static int	DTD_VALIDATION
static int	NONVALIDATING
static int	SCHEMA_VALIDATION

Constructor Summary

protected	XMLUnmarshaller(XMLContext xmlContext)
protected	XMLUnmarshaller(XMLContext xmlContext, java.util.Map<java.lang.String,java.lang.Boolean> parserFeatures)

Method Summary

XMLUnmarshaller	clone()
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
IDResolver	getIDResolver() Return this Unmarshaller's custom IDResolver.
MediaType	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()
org.eclipse.persistence.internal.oxm.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
XMLUnmarshallerHandler	getUnmarshallerHandler()
XMLUnmarshalListener	getUnmarshalListener()
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.
XMLContext	getXMLContext() Return the instance of XMLContext that was used to create this instance of XMLUnmarshaller.
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	isIncludeRoot() Determine if the @XMLRootElement should be marshalled when present.
boolean	isResultAlwaysXMLRoot()
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	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(IDResolver idResolver) Set this Unmarshaller's custom IDResolver.
void	setIncludeRoot(boolean includeRoot) Determine if the @XMLRootElement should be marshalled when present.
void	setMediaType(MediaType 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	setUnmarshalListener(XMLUnmarshalListener listener)
void	setValidationMode(int validationMode) Set the validation mode.
void	setValueWrapper(java.lang.String valueWrapper) Name of the property to marshal/unmarshal as a wrapper on the text() mappings Ignored unmarshalling XML.
void	setWrapperAsCollectionName(boolean wrapperAsCollectionName) since 2.4.2
void	setXMLContext(XMLContext value) Set the XMLContext used by this instance of XMLUnmarshaller.
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 java.lang.Object

equals, finalize, 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

Constructor Detail

XMLUnmarshaller

protected XMLUnmarshaller(XMLContext xmlContext)

XMLUnmarshaller

protected XMLUnmarshaller(XMLContext xmlContext,
                          java.util.Map<java.lang.String,java.lang.Boolean> parserFeatures)

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

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 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

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

getUnmarshalListener

public XMLUnmarshalListener getUnmarshalListener()

setUnmarshalListener

public void setUnmarshalListener(XMLUnmarshalListener listener)

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

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 org.eclipse.persistence.internal.oxm.StrBuffer getStringBuffer()

INTERNAL: This is the text handler during unmarshal operations.

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.

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 XMLUnmarshallerHandler getUnmarshallerHandler()

getAttachmentUnmarshaller

public XMLAttachmentUnmarshaller getAttachmentUnmarshaller()

setAttachmentUnmarshaller

public void setAttachmentUnmarshaller(XMLAttachmentUnmarshaller atu)

setResultAlwaysXMLRoot

public void setResultAlwaysXMLRoot(boolean alwaysReturnRoot)

isResultAlwaysXMLRoot

public boolean isResultAlwaysXMLRoot()

setSchema

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

getSchema

public javax.xml.validation.Schema getSchema()

getAttributePrefix

public java.lang.String getAttributePrefix()

Value that will be used to prefix attributes. Ignored unmarshalling XML.

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.

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

isWrapperAsCollectionName

public boolean isWrapperAsCollectionName()

Since:

2.4.2

setWrapperAsCollectionName

public void setWrapperAsCollectionName(boolean wrapperAsCollectionName)

since 2.4.2

getNamespaceSeparator

public char getNamespaceSeparator()

Get the namespace separator used during unmarshal operations. If mediaType is application/json '.' is the default Ignored unmarshalling XML.

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.

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)

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)

getNamespaceResolver

public NamespaceResolver getNamespaceResolver()

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

Since:

2.4

setNamespaceResolver

public void setNamespaceResolver(NamespaceResolver namespaceResolver)

Get the NamespaceResolver to be used during unmarshal Ignored unmarshalling XML.

Since:

2.4

clone

public XMLUnmarshaller clone()

Overrides:

clone in class java.lang.Object

getIDResolver

public IDResolver getIDResolver()

Return this Unmarshaller's custom IDResolver.

Returns:

the custom IDResolver, or null if one has not been specified.

See Also:

IDResolver

Since:

2.3.3

setIDResolver

public void setIDResolver(IDResolver idResolver)

Set this Unmarshaller's custom IDResolver.

See Also:

IDResolver

Since:

2.3.3