public class XMLUnmarshaller extends Unmarshaller<AbstractSession,XMLContext,XMLDescriptor,IDResolver,MediaType,XMLRoot,XMLUnmarshallerHandler> implements Cloneable
Class used to unmarshal XML to objects.
Create an XMLUnmarshaller from an XMLContext. 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.
Code Sample
XMLContext context = new XMLContext("mySessionName");
XMLUnmarshaller unmarshaller = context.createUnmarshaller();
XMLContext
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() |
XMLRoot |
createRoot()
INTERNAL
|
UnmarshalRecord |
createRootUnmarshalRecord(Class clazz)
INTERNAL
|
UnmarshalRecord |
createUnmarshalRecord(XMLDescriptor xmlDescriptor,
AbstractSession session)
INTERNAL
|
XMLAttachmentUnmarshaller |
getAttachmentUnmarshaller() |
String |
getAttributePrefix()
Value that will be used to prefix attributes.
|
EntityResolver |
getEntityResolver()
Get the EntityResolver set on this XMLUnmarshaller
|
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.
|
Properties |
getProperties()
Return a properties object for a given instance of the
XMLUnmarshaller.
|
Object |
getProperty(Object key)
Return the property for a given key, if one exists.
|
Schema |
getSchema() |
StrBuffer |
getStringBuffer()
INTERNAL:
This is the text handler during unmarshal operations.
|
Class |
getUnmappedContentHandlerClass()
Get the class that will be instantiated to handled unmapped content
Class must implement the org.eclipse.persistence.oxm.unmapped.UnmappedContentHandler interface
|
Object |
getUnmarshalAttributeGroup()
INTERNAL:
Returns the AttributeGroup or the name of the AttributeGroup to be used to
unmarshal.
|
XMLUnmarshallerHandler |
getUnmarshallerHandler() |
XMLUnmarshalListener |
getUnmarshalListener() |
int |
getValidationMode()
Get the validation mode set on this XMLUnmarshaller
By default, the unmarshaller is set to be NONVALIDATING
|
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(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(EntityResolver entityResolver)
Set the EntityResolver on this XMLUnmarshaller
|
void |
setErrorHandler(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(Schema schema) |
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
|
void |
setUnmarshalAttributeGroup(Object attributeGroup) |
void |
setUnmarshalListener(XMLUnmarshalListener listener) |
void |
setValidationMode(int validationMode)
Set the validation mode.
|
void |
setValueWrapper(String valueWrapper)
Name of the property to marshal/unmarshal as a wrapper on the text() mappings
Ignored unmarshalling XML.
|
void |
setWrapperAsCollectionName(boolean wrapperAsCollectionName) |
void |
setXMLContext(XMLContext value)
Set the XMLContext used by this instance of XMLUnmarshaller.
|
Object |
unmarshal(File file)
PUBLIC:
Read and parse the XML document from the file and map the XML data into an object.
|
Object |
unmarshal(File file,
Class clazz)
PUBLIC:
Read and parse the XML document from the file and map the XML data into an object.
|
Object |
unmarshal(InputSource inputSource)
PUBLIC:
Read and parse the XML document from the inputSource and map the XML data into an object.
|
Object |
unmarshal(InputSource inputSource,
Class clazz)
PUBLIC:
Read and parse the XML document from the inputSource and map the XML data into an object.
|
Object |
unmarshal(InputStream inputStream)
PUBLIC:
Read and parse the XML document from the inputStream and map the XML data into an object.
|
Object |
unmarshal(InputStream inputStream,
Class clazz)
PUBLIC:
Read and parse the XML document from the inputStream and map the XML data into an object.
|
Object |
unmarshal(Node node)
PUBLIC:
Map the XML node into an object.
|
Object |
unmarshal(Node node,
Class clazz)
PUBLIC:
Map the XML node into an object.
|
Object |
unmarshal(Reader reader)
PUBLIC:
Read and parse the XML document from the reader and map the XML data into an object.
|
Object |
unmarshal(Reader reader,
Class clazz)
PUBLIC:
Read and parse the XML document from the reader and map the XML data into an object.
|
Object |
unmarshal(Source source)
PUBLIC:
Read and parse the XML document from the source and map the XML data into an object.
|
Object |
unmarshal(Source source,
Class clazz)
PUBLIC:
Read and parse the XML document from the source and map the XML data into an object.
|
Object |
unmarshal(URL url)
PUBLIC:
Read and parse the XML document from the url and map the XML data into an object.
|
Object |
unmarshal(URL url,
Class clazz)
PUBLIC:
Read and parse the XML document from the url and map the XML data into an object.
|
Object |
unmarshal(XMLReader xmlReader,
InputSource inputSource) |
Object |
unmarshal(XMLReader xmlReader,
InputSource inputSource,
Class clazz) |
getContext
public static final int NONVALIDATING
public static final int SCHEMA_VALIDATION
public static final int DTD_VALIDATION
public void setMediaType(MediaType mediaType)
mediaType
- public MediaType getMediaType()
getMediaType
in class Unmarshaller<AbstractSession,XMLContext,XMLDescriptor,IDResolver,MediaType,XMLRoot,XMLUnmarshallerHandler>
public XMLContext getXMLContext()
public void setXMLContext(XMLContext value)
public int getValidationMode()
public void setValidationMode(int validationMode)
validationMode
- sets the type of the validation mode to be usedpublic EntityResolver getEntityResolver()
public void setEntityResolver(EntityResolver entityResolver)
entityResolver
- the EntityResolver to set on this XMLUnmarshallerpublic ErrorHandler getErrorHandler()
getErrorHandler
in class Unmarshaller<AbstractSession,XMLContext,XMLDescriptor,IDResolver,MediaType,XMLRoot,XMLUnmarshallerHandler>
public void setErrorHandler(ErrorHandler errorHandler)
errorHandler
- the ErrorHandler to set on this XMLUnmarshallerpublic XMLUnmarshalListener getUnmarshalListener()
getUnmarshalListener
in class Unmarshaller<AbstractSession,XMLContext,XMLDescriptor,IDResolver,MediaType,XMLRoot,XMLUnmarshallerHandler>
public void setUnmarshalListener(XMLUnmarshalListener listener)
public Class getUnmappedContentHandlerClass()
getUnmappedContentHandlerClass
in class Unmarshaller<AbstractSession,XMLContext,XMLDescriptor,IDResolver,MediaType,XMLRoot,XMLUnmarshallerHandler>
public void setUnmappedContentHandlerClass(Class aClass)
aClass
- public StrBuffer getStringBuffer()
getStringBuffer
in class Unmarshaller<AbstractSession,XMLContext,XMLDescriptor,IDResolver,MediaType,XMLRoot,XMLUnmarshallerHandler>
public Object unmarshal(File file) throws XMLMarshalException
file
- The file to unmarshal fromXMLMarshalException
- if an error occurred during unmarshallingpublic Object unmarshal(File file, Class clazz) throws XMLMarshalException
file
- The file to unmarshal fromclazz
- The type of object to return.XMLMarshalException
- if an error occurred during unmarshallingpublic Object unmarshal(InputStream inputStream) throws XMLMarshalException
inputStream
- The inputStream to unmarshal fromXMLMarshalException
- if an error occurred during unmarshallingpublic Object unmarshal(InputStream inputStream, Class clazz) throws XMLMarshalException
inputStream
- The inputStream to unmarshal fromclazz
- The type of object to return.XMLMarshalException
- if an error occurred during unmarshallingpublic Object unmarshal(Reader reader) throws XMLMarshalException
reader
- The reader to unmarshal fromXMLMarshalException
- if an error occurred during unmarshallingpublic Object unmarshal(Reader reader, Class clazz) throws XMLMarshalException
reader
- The reader to unmarshal fromclazz
- The type of object to return.XMLMarshalException
- if an error occurred during unmarshallingpublic Object unmarshal(URL url) throws XMLMarshalException
url
- The url to unmarshal fromXMLMarshalException
- if an error occurred during unmarshallingpublic Object unmarshal(URL url, Class clazz) throws XMLMarshalException
url
- The url to unmarshal fromclazz
- The type of object to return.XMLMarshalException
- if an error occurred during unmarshallingpublic Object unmarshal(InputSource inputSource) throws XMLMarshalException
inputSource
- The inputSource to unmarshal fromXMLMarshalException
- if an error occurred during unmarshallingpublic Object unmarshal(InputSource inputSource, Class clazz) throws XMLMarshalException
inputSource
- The inputSource to unmarshal fromclazz
- The type of object to return.XMLMarshalException
- if an error occurred during unmarshallingpublic Object unmarshal(Node node) throws XMLMarshalException
node
- The node to unmarshal fromXMLMarshalException
- if an error occurred during unmarshallingpublic Object unmarshal(Node node, Class clazz) throws XMLMarshalException
node
- The node to unmarshal fromclazz
- The type of object to return.XMLMarshalException
- if an error occurred during unmarshallingpublic Object unmarshal(Source source) throws XMLMarshalException
source
- The source to unmarshal fromXMLMarshalException
- if an error occurred during unmarshallingpublic Properties getProperties()
public Object getProperty(Object key)
getProperty
in class Unmarshaller<AbstractSession,XMLContext,XMLDescriptor,IDResolver,MediaType,XMLRoot,XMLUnmarshallerHandler>
public Object unmarshal(Source source, Class clazz) throws XMLMarshalException
source
- The inputSource to unmarshal fromclazz
- The type of object to return.XMLMarshalException
- if an error occurred during unmarshallingpublic Object unmarshal(XMLReader xmlReader, InputSource inputSource)
public Object unmarshal(XMLReader xmlReader, InputSource inputSource, Class clazz)
public XMLUnmarshallerHandler getUnmarshallerHandler()
getUnmarshallerHandler
in class Unmarshaller<AbstractSession,XMLContext,XMLDescriptor,IDResolver,MediaType,XMLRoot,XMLUnmarshallerHandler>
public XMLAttachmentUnmarshaller getAttachmentUnmarshaller()
getAttachmentUnmarshaller
in class Unmarshaller<AbstractSession,XMLContext,XMLDescriptor,IDResolver,MediaType,XMLRoot,XMLUnmarshallerHandler>
public void setAttachmentUnmarshaller(XMLAttachmentUnmarshaller atu)
public void setResultAlwaysXMLRoot(boolean alwaysReturnRoot)
public boolean isResultAlwaysXMLRoot()
isResultAlwaysXMLRoot
in class Unmarshaller<AbstractSession,XMLContext,XMLDescriptor,IDResolver,MediaType,XMLRoot,XMLUnmarshallerHandler>
public void setSchema(Schema schema)
public Schema getSchema()
getSchema
in class Unmarshaller<AbstractSession,XMLContext,XMLDescriptor,IDResolver,MediaType,XMLRoot,XMLUnmarshallerHandler>
public String getAttributePrefix()
getAttributePrefix
in class Unmarshaller<AbstractSession,XMLContext,XMLDescriptor,IDResolver,MediaType,XMLRoot,XMLUnmarshallerHandler>
public void setAttributePrefix(String attributePrefix)
public String getValueWrapper()
getValueWrapper
in class Unmarshaller<AbstractSession,XMLContext,XMLDescriptor,IDResolver,MediaType,XMLRoot,XMLUnmarshallerHandler>
public void setValueWrapper(String valueWrapper)
public char getNamespaceSeparator()
getNamespaceSeparator
in class Unmarshaller<AbstractSession,XMLContext,XMLDescriptor,IDResolver,MediaType,XMLRoot,XMLUnmarshallerHandler>
public void setNamespaceSeparator(char namespaceSeparator)
public boolean isIncludeRoot()
isIncludeRoot
in class Unmarshaller<AbstractSession,XMLContext,XMLDescriptor,IDResolver,MediaType,XMLRoot,XMLUnmarshallerHandler>
public void setIncludeRoot(boolean includeRoot)
public boolean isAutoDetectMediaType()
isAutoDetectMediaType
in class Unmarshaller<AbstractSession,XMLContext,XMLDescriptor,IDResolver,MediaType,XMLRoot,XMLUnmarshallerHandler>
public void setAutoDetectMediaType(boolean autoDetectMediaType)
public NamespaceResolver getNamespaceResolver()
getNamespaceResolver
in class Unmarshaller<AbstractSession,XMLContext,XMLDescriptor,IDResolver,MediaType,XMLRoot,XMLUnmarshallerHandler>
public void setNamespaceResolver(NamespaceResolver namespaceResolver)
public boolean isWrapperAsCollectionName()
isWrapperAsCollectionName
in class Unmarshaller<AbstractSession,XMLContext,XMLDescriptor,IDResolver,MediaType,XMLRoot,XMLUnmarshallerHandler>
public void setWrapperAsCollectionName(boolean wrapperAsCollectionName)
public XMLUnmarshaller clone()
public IDResolver getIDResolver()
getIDResolver
in class Unmarshaller<AbstractSession,XMLContext,XMLDescriptor,IDResolver,MediaType,XMLRoot,XMLUnmarshallerHandler>
IDResolver
public void setIDResolver(IDResolver idResolver)
setIDResolver
in class Unmarshaller<AbstractSession,XMLContext,XMLDescriptor,IDResolver,MediaType,XMLRoot,XMLUnmarshallerHandler>
IDResolver
public XMLRoot createRoot()
createRoot
in class Unmarshaller<AbstractSession,XMLContext,XMLDescriptor,IDResolver,MediaType,XMLRoot,XMLUnmarshallerHandler>
public UnmarshalRecord createRootUnmarshalRecord(Class clazz)
createRootUnmarshalRecord
in class Unmarshaller<AbstractSession,XMLContext,XMLDescriptor,IDResolver,MediaType,XMLRoot,XMLUnmarshallerHandler>
public UnmarshalRecord createUnmarshalRecord(XMLDescriptor xmlDescriptor, AbstractSession session)
createUnmarshalRecord
in class Unmarshaller<AbstractSession,XMLContext,XMLDescriptor,IDResolver,MediaType,XMLRoot,XMLUnmarshallerHandler>
public Object getUnmarshalAttributeGroup()
getUnmarshalAttributeGroup
in class Unmarshaller<AbstractSession,XMLContext,XMLDescriptor,IDResolver,MediaType,XMLRoot,XMLUnmarshallerHandler>
public void setUnmarshalAttributeGroup(Object attributeGroup)
EclipseLink 2.5.2, "build v20140319-9ad6abd" API Reference