Package org.glassfish.jaxb.runtime.v2.runtime.unmarshaller

Class UnmarshallerImpl

java.lang.Object

jakarta.xml.bind.helpers.AbstractUnmarshallerImpl

org.glassfish.jaxb.runtime.v2.runtime.unmarshaller.UnmarshallerImpl

All Implemented Interfaces:

Unmarshaller, ValidationEventHandler, Closeable, AutoCloseable

public final class UnmarshallerImpl
extends AbstractUnmarshallerImpl
implements ValidationEventHandler, Closeable

Default Unmarshaller implementation.

This class can be extended by the generated code to provide type-safe unmarshall methods.

Author:

Kohsuke KAWAGUCHI

Nested Class Summary

Nested classes/interfaces inherited from interface jakarta.xml.bind.Unmarshaller

Unmarshaller.Listener

Field Summary

Fields

Modifier and Type	Field	Description
protected final JAXBContextImpl	context	Owning JAXBContext
final UnmarshallingContext	coordinator
static final String	FACTORY

Constructor Summary

Constructors

Constructor	Description
UnmarshallerImpl(JAXBContextImpl context, AssociationMap assoc)

Method Summary

Modifier and Type	Method	Description
void	close()	Must be called from same thread which created the UnmarshallerImpl instance.
UnmarshalException	createUnmarshalException(SAXException e)	Creates an UnmarshalException from a SAXException.
XmlVisitor	createUnmarshallerHandler(InfosetScanner scanner, boolean inplace, JaxBeanInfo expectedType)	Creates and configures a new unmarshalling pipe line.
protected void	finalize()
<A extends XmlAdapter<?, ?>> A	getAdapter(Class<A> type)	Gets the adapter associated with the specified type.
AttachmentUnmarshaller	getAttachmentUnmarshaller()
<T> JaxBeanInfo<T>	getBeanInfo(Class<T> clazz)
UnmarshallingContext	getContext()
ValidationEventHandler	getEventHandler()	Return the current event handler or the default event handler if one hasn't been set.
Unmarshaller.Listener	getListener()	Return Unmarshaller.Listener registered with this Unmarshaller.
Object	getProperty(String name)	Default implementation of the getProperty method always throws PropertyException since there are no required properties.
Schema	getSchema()	Get the JAXP Schema object being used to perform unmarshal-time validation.
UnmarshallerHandler	getUnmarshallerHandler()	Get an unmarshaller handler object that can be used as a component in an XML pipeline.
protected XMLReader	getXMLReader()	Obtains a configured XMLReader.
boolean	handleEvent(ValidationEvent event)	Default error handling behavior for Unmarshaller.
boolean	hasEventHandler()	Returns true if an event handler is installed.
boolean	isValidating()	Deprecated. since 2.0
static boolean	needsInterning(XMLReader reader)
<A extends XmlAdapter<?, ?>> void	setAdapter(Class<A> type, A adapter)	Associates a configured instance of XmlAdapter with this unmarshaller.
void	setAttachmentUnmarshaller(AttachmentUnmarshaller au)	Associate a context that resolves cid's, content-id URIs, to binary data passed as attachments.
void	setListener(Unmarshaller.Listener listener)	Register unmarshal event callback Unmarshaller.Listener with this Unmarshaller.
void	setProperty(String name, Object value)	Default implementation of the setProperty method always throws PropertyException since there are no required properties.
void	setSchema(Schema schema)	Specify the JAXP Schema object that should be used to validate subsequent unmarshal operations against.
void	setValidating(boolean validating)	Deprecated. since 2.0
Object	unmarshal(XMLEventReader reader)	Unmarshal XML data from the specified pull parser and return the resulting content tree.
<T> JAXBElement<T>	unmarshal(XMLEventReader reader, Class<T> expectedType)	Unmarshal root element to Jakarta XML Binding mapped declaredType and return the resulting content tree.
Object	unmarshal(XMLStreamReader reader)	Unmarshal XML data from the specified pull parser and return the resulting content tree.
<T> JAXBElement<T>	unmarshal(XMLStreamReader reader, Class<T> expectedType)	Unmarshal root element to Jakarta XML Binding mapped declaredType and return the resulting content tree.
Object	unmarshal(SAXSource source)	Deprecated.
<T> JAXBElement<T>	unmarshal(Source source, Class<T> expectedType)	Unmarshal XML data from the specified XML Source by declaredType and return the resulting content tree.
Object	unmarshal(Node node)	Unmarshal global XML data from the specified DOM tree and return the resulting content tree.
<T> JAXBElement<T>	unmarshal(Node node, Class<T> expectedType)	Unmarshal XML data by Jakarta XML Binding mapped declaredType and return the resulting content tree.
protected Object	unmarshal(XMLReader reader, InputSource source)	Unmarshalls an object by using the specified XMLReader and the InputSource.
protected <T> JAXBElement<T>	unmarshal(XMLReader reader, InputSource source, Class<T> expectedType)
Object	unmarshal0(InputStream input, JaxBeanInfo expectedType)
Object	unmarshal0(XMLStreamReader reader, JaxBeanInfo expectedType)
Object	unmarshal0(Source source, JaxBeanInfo expectedType)
Object	unmarshal0(Node node, JaxBeanInfo expectedType)

Methods inherited from class jakarta.xml.bind.helpers.AbstractUnmarshallerImpl

setAdapter, setEventHandler, unmarshal, unmarshal, unmarshal, unmarshal, unmarshal, unmarshal

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

context

protected final JAXBContextImpl context

Owning JAXBContext

coordinator

public final UnmarshallingContext coordinator

FACTORY

public static final String FACTORY

See Also:

• Constant Field Values

Constructor Details

UnmarshallerImpl

public UnmarshallerImpl(JAXBContextImpl context,
 AssociationMap assoc)

Method Details

getUnmarshallerHandler

public UnmarshallerHandler getUnmarshallerHandler()

Description copied from interface: Unmarshaller

Get an unmarshaller handler object that can be used as a component in an XML pipeline.

The Jakarta XML Binding Provider can return the same handler object for multiple invocations of this method. In other words, this method does not necessarily create a new instance of UnmarshallerHandler. If the application needs to use more than one UnmarshallerHandler, it should create more than one Unmarshaller.

Specified by:

getUnmarshallerHandler in interface Unmarshaller

Returns:

the unmarshaller handler object

See Also:

• UnmarshallerHandler

getXMLReader

protected XMLReader getXMLReader()
                          throws JAXBException

Obtains a configured XMLReader. This method is used when the client-specified SAXSource object doesn't have XMLReader. Unmarshaller is not re-entrant, so we will only use one instance of XMLReader. Overriden in order to fix potential security issue.

Overrides:

getXMLReader in class AbstractUnmarshallerImpl

Throws:

JAXBException

createUnmarshallerHandler

public XmlVisitor createUnmarshallerHandler(InfosetScanner scanner,
 boolean inplace,
 JaxBeanInfo expectedType)

Creates and configures a new unmarshalling pipe line. Depending on the setting, we put a validator as a filter.

Returns:

A component that implements both UnmarshallerHandler and ValidationEventHandler. All the parsing errors should be reported to this error handler for the unmarshalling process to work correctly. Also, returned handler expects all the XML names to be interned.

needsInterning

public static boolean needsInterning(XMLReader reader)

unmarshal

protected Object unmarshal(XMLReader reader,
 InputSource source)
                    throws JAXBException

Description copied from class: AbstractUnmarshallerImpl

Unmarshalls an object by using the specified XMLReader and the InputSource.

The callee should call the setErrorHandler method of the XMLReader so that errors are passed to the client-specified ValidationEventHandler.

Specified by:

unmarshal in class AbstractUnmarshallerImpl

Throws:

JAXBException

unmarshal

protected <T> JAXBElement<T> unmarshal(XMLReader reader,
 InputSource source,
 Class<T> expectedType)
                                throws JAXBException

Throws:

JAXBException

unmarshal

public <T> JAXBElement<T> unmarshal(Source source,
 Class<T> expectedType)
                             throws JAXBException

Description copied from interface: Unmarshaller

Unmarshal XML data from the specified XML Source by declaredType and return the resulting content tree.

Implements Unmarshal by Declared Type

See SAX 2.0 Parser Pluggability

Specified by:

unmarshal in interface Unmarshaller

Overrides:

unmarshal in class AbstractUnmarshallerImpl

Type Parameters:

T - the XML Binding mapped class

Parameters:

source - the XML Source to unmarshal XML data from (providers are only required to support SAXSource, DOMSource, and StreamSource)

expectedType - appropriate Jakarta XML Binding mapped class to hold source's xml root element

Returns:

Java content rooted by JAXBElement

Throws:

JAXBException - If any unexpected errors occur while unmarshalling

UnmarshalException - If the ValidationEventHandler returns false from its handleEvent method or the Unmarshaller is unable to perform the XML to Java binding. See Unmarshalling XML Data

unmarshal0

public Object unmarshal0(Source source,
 JaxBeanInfo expectedType)
                  throws JAXBException

Throws:

JAXBException

getEventHandler

public ValidationEventHandler getEventHandler()

Description copied from class: AbstractUnmarshallerImpl

Return the current event handler or the default event handler if one hasn't been set.

Specified by:

getEventHandler in interface Unmarshaller

Overrides:

getEventHandler in class AbstractUnmarshallerImpl

Returns:

the current ValidationEventHandler or the default event handler if it hasn't been set

hasEventHandler

public boolean hasEventHandler()

Returns true if an event handler is installed.

The default handler ignores any errors, and for that this method returns false.

unmarshal

public <T> JAXBElement<T> unmarshal(Node node,
 Class<T> expectedType)
                             throws JAXBException

Description copied from interface: Unmarshaller

Unmarshal XML data by Jakarta XML Binding mapped declaredType and return the resulting content tree.

Implements Unmarshal by Declared Type

Specified by:

unmarshal in interface Unmarshaller

Overrides:

unmarshal in class AbstractUnmarshallerImpl

Type Parameters:

T - the XML Binding mapped class

Parameters:

node - the document/element to unmarshal XML data from. The caller must support at least Document and Element.

expectedType - appropriate Jakarta XML Binding mapped class to hold node's XML data.

Returns:

JAXBElement representation of node

Throws:

JAXBException - If any unexpected errors occur while unmarshalling

UnmarshalException - If the ValidationEventHandler returns false from its handleEvent method or the Unmarshaller is unable to perform the XML to Java binding. See Unmarshalling XML Data

unmarshal

public Object unmarshal(Node node)
                 throws JAXBException

Description copied from interface: Unmarshaller

Unmarshal global XML data from the specified DOM tree and return the resulting content tree.

Implements Unmarshal Global Root Element.

Specified by:

unmarshal in interface Unmarshaller

Parameters:

node - the document/element to unmarshal XML data from. The caller must support at least Document and Element.

Returns:

the newly created root object of the java content tree

Throws:

JAXBException - If any unexpected errors occur while unmarshalling

UnmarshalException - If the ValidationEventHandler returns false from its handleEvent method or the Unmarshaller is unable to perform the XML to Java binding. See Unmarshalling XML Data

See Also:

• Unmarshaller.unmarshal(org.w3c.dom.Node, Class)

unmarshal

@Deprecated
public Object unmarshal(SAXSource source)
                 throws JAXBException

Deprecated.

Throws:

JAXBException

unmarshal0

public Object unmarshal0(Node node,
 JaxBeanInfo expectedType)
                  throws JAXBException

Throws:

JAXBException

unmarshal

public Object unmarshal(XMLStreamReader reader)
                 throws JAXBException

Description copied from interface: Unmarshaller

Unmarshal XML data from the specified pull parser and return the resulting content tree.

Implements Unmarshal Global Root Element.

This method assumes that the parser is on a START_DOCUMENT or START_ELEMENT event. Unmarshalling will be done from this start event to the corresponding end event. If this method returns successfully, the reader will be pointing at the token right after the end event.

Specified by:

unmarshal in interface Unmarshaller

Overrides:

unmarshal in class AbstractUnmarshallerImpl

Parameters:

reader - The parser to be read.

Returns:

the newly created root object of the java content tree.

Throws:

JAXBException - If any unexpected errors occur while unmarshalling

UnmarshalException - If the ValidationEventHandler returns false from its handleEvent method or the Unmarshaller is unable to perform the XML to Java binding. See Unmarshalling XML Data

See Also:

• Unmarshaller.unmarshal(javax.xml.stream.XMLStreamReader, Class)

unmarshal

public <T> JAXBElement<T> unmarshal(XMLStreamReader reader,
 Class<T> expectedType)
                             throws JAXBException

Description copied from interface: Unmarshaller

Unmarshal root element to Jakarta XML Binding mapped declaredType and return the resulting content tree.

This method implements unmarshal by declaredType.

This method assumes that the parser is on a START_DOCUMENT or START_ELEMENT event. Unmarshalling will be done from this start event to the corresponding end event. If this method returns successfully, the reader will be pointing at the token right after the end event.

Specified by:

unmarshal in interface Unmarshaller

Overrides:

unmarshal in class AbstractUnmarshallerImpl

Type Parameters:

T - the XML Binding mapped class

Parameters:

reader - The parser to be read.

expectedType - appropriate Jakarta XML Binding mapped class to hold reader's START_ELEMENT XML data.

Returns:

content tree rooted by JAXBElement representation

Throws:

JAXBException - If any unexpected errors occur while unmarshalling

UnmarshalException - If the ValidationEventHandler returns false from its handleEvent method or the Unmarshaller is unable to perform the XML to Java binding. See Unmarshalling XML Data

unmarshal0

public Object unmarshal0(XMLStreamReader reader,
 JaxBeanInfo expectedType)
                  throws JAXBException

Throws:

JAXBException

unmarshal

public <T> JAXBElement<T> unmarshal(XMLEventReader reader,
 Class<T> expectedType)
                             throws JAXBException

Description copied from interface: Unmarshaller

Unmarshal root element to Jakarta XML Binding mapped declaredType and return the resulting content tree.

This method implements unmarshal by declaredType.

This method assumes that the parser is on a START_DOCUMENT or START_ELEMENT event. Unmarshalling will be done from this start event to the corresponding end event. If this method returns successfully, the reader will be pointing at the token right after the end event.

Specified by:

unmarshal in interface Unmarshaller

Overrides:

unmarshal in class AbstractUnmarshallerImpl

Type Parameters:

T - the XML Binding mapped class

Parameters:

reader - The parser to be read.

expectedType - appropriate Jakarta XML Binding mapped class to hold reader's START_ELEMENT XML data.

Returns:

content tree rooted by JAXBElement representation

Throws:

JAXBException - If any unexpected errors occur while unmarshalling

UnmarshalException - If the ValidationEventHandler returns false from its handleEvent method or the Unmarshaller is unable to perform the XML to Java binding. See Unmarshalling XML Data

unmarshal

public Object unmarshal(XMLEventReader reader)
                 throws JAXBException

Description copied from interface: Unmarshaller

Unmarshal XML data from the specified pull parser and return the resulting content tree.

This method is an Unmarshal Global Root method.

This method assumes that the parser is on a START_DOCUMENT or START_ELEMENT event. Unmarshalling will be done from this start event to the corresponding end event. If this method returns successfully, the reader will be pointing at the token right after the end event.

Specified by:

unmarshal in interface Unmarshaller

Overrides:

unmarshal in class AbstractUnmarshallerImpl

Parameters:

reader - The parser to be read.

Returns:

the newly created root object of the java content tree.

Throws:

JAXBException - If any unexpected errors occur while unmarshalling

UnmarshalException - If the ValidationEventHandler returns false from its handleEvent method or the Unmarshaller is unable to perform the XML to Java binding. See Unmarshalling XML Data

See Also:

• Unmarshaller.unmarshal(javax.xml.stream.XMLEventReader, Class)

unmarshal0

public Object unmarshal0(InputStream input,
 JaxBeanInfo expectedType)
                  throws JAXBException

Throws:

JAXBException

getProperty

public Object getProperty(String name)
                   throws PropertyException

Description copied from class: AbstractUnmarshallerImpl

Default implementation of the getProperty method always throws PropertyException since there are no required properties. If a provider needs to handle additional properties, it should override this method in a derived class.

Specified by:

getProperty in interface Unmarshaller

Overrides:

getProperty in class AbstractUnmarshallerImpl

Parameters:

name - the name of the property to retrieve

Returns:

the value of the requested property

Throws:

PropertyException - when there is an error retrieving the given property or value property name

setProperty

public void setProperty(String name,
 Object value)
                 throws PropertyException

Description copied from class: AbstractUnmarshallerImpl

Default implementation of the setProperty method always throws PropertyException since there are no required properties. If a provider needs to handle additional properties, it should override this method in a derived class.

Specified by:

setProperty in interface Unmarshaller

Overrides:

setProperty in class AbstractUnmarshallerImpl

Parameters:

name - the name of the property to be set. This value can either be specified using one of the constant fields or a user supplied string.

value - the value of the property to be set

Throws:

PropertyException - when there is an error processing the given property or value

setSchema

public void setSchema(Schema schema)

Description copied from interface: Unmarshaller

Specify the JAXP Schema object that should be used to validate subsequent unmarshal operations against. Passing null into this method will disable validation.

Initially this property is set to null.

Specified by:

setSchema in interface Unmarshaller

Overrides:

setSchema in class AbstractUnmarshallerImpl

Parameters:

schema - Schema object to validate unmarshal operations against or null to disable validation

getSchema

public Schema getSchema()

Description copied from interface: Unmarshaller

Get the JAXP Schema object being used to perform unmarshal-time validation. If there is no Schema set on the unmarshaller, then this method will return null indicating that unmarshal-time validation will not be performed.

Specified by:

getSchema in interface Unmarshaller

Overrides:

getSchema in class AbstractUnmarshallerImpl

Returns:

the Schema object being used to perform unmarshal-time validation or null if not present

getAttachmentUnmarshaller

public AttachmentUnmarshaller getAttachmentUnmarshaller()

Specified by:

getAttachmentUnmarshaller in interface Unmarshaller

Overrides:

getAttachmentUnmarshaller in class AbstractUnmarshallerImpl

setAttachmentUnmarshaller

public void setAttachmentUnmarshaller(AttachmentUnmarshaller au)

Description copied from interface: Unmarshaller

Associate a context that resolves cid's, content-id URIs, to binary data passed as attachments. Unmarshal time validation, enabled via Unmarshaller.setSchema(Schema), must be supported even when unmarshaller is performing XOP processing.

Specified by:

setAttachmentUnmarshaller in interface Unmarshaller

Overrides:

setAttachmentUnmarshaller in class AbstractUnmarshallerImpl

Parameters:

au - the attachment unmarshaller to be set

isValidating

@Deprecated
public boolean isValidating()

Deprecated.

since 2.0

setValidating

@Deprecated
public void setValidating(boolean validating)

Deprecated.

since 2.0

setAdapter

public <A extends XmlAdapter<?,
?>> void setAdapter(Class<A> type,
 A adapter)

Description copied from interface: Unmarshaller

Associates a configured instance of XmlAdapter with this unmarshaller.

Every unmarshaller internally maintains a Map<Class,XmlAdapter>, which it uses for unmarshalling classes whose fields/methods are annotated with XmlJavaTypeAdapter.

This method allows applications to use a configured instance of XmlAdapter. When an instance of an adapter is not given, an unmarshaller will create one by invoking its default constructor.

Specified by:

setAdapter in interface Unmarshaller

Overrides:

setAdapter in class AbstractUnmarshallerImpl

Type Parameters:

A - the type of the adapter

Parameters:

type - The type of the adapter. The specified instance will be used when XmlJavaTypeAdapter.value() refers to this type.

adapter - The instance of the adapter to be used. If null, it will un-register the current adapter set for this type.

getAdapter

public <A extends XmlAdapter<?,
?>> A getAdapter(Class<A> type)

Description copied from interface: Unmarshaller

Gets the adapter associated with the specified type. This is the reverse operation of the Unmarshaller.setAdapter(A) method.

Specified by:

getAdapter in interface Unmarshaller

Overrides:

getAdapter in class AbstractUnmarshallerImpl

Type Parameters:

A - the type of the adapter

Parameters:

type - The type of the adapter. The specified instance will be used when XmlJavaTypeAdapter.value() refers to this type.

Returns:

The adapter associated with the specified type.

createUnmarshalException

public UnmarshalException createUnmarshalException(SAXException e)

Description copied from class: AbstractUnmarshallerImpl

Creates an UnmarshalException from a SAXException.

This is a utility method provided for the derived classes.

When a provider-implemented ContentHandler wants to throw a JAXBException, it needs to wrap the exception by a SAXException. If the unmarshaller implementation blindly wrap SAXException by JAXBException, such an exception will be a JAXBException wrapped by a SAXException wrapped by another JAXBException. This is silly.

This method checks the nested exception to SAXException and reduce those excessive wrapping.

Overrides:

createUnmarshalException in class AbstractUnmarshallerImpl

Returns:

the resulting UnmarshalException

handleEvent

public boolean handleEvent(ValidationEvent event)

Default error handling behavior for Unmarshaller.

Specified by:

handleEvent in interface ValidationEventHandler

Parameters:

event - the encapsulated validation event information. It is a provider error if this parameter is null.

Returns:

true if the Jakarta XML Binding Provider should attempt to continue the current unmarshal, validate, or marshal operation after handling this warning/error, false if the provider should terminate the current operation with the appropriate UnmarshalException, ValidationException, or MarshalException.

getBeanInfo

public <T> JaxBeanInfo<T> getBeanInfo(Class<T> clazz)
                               throws JAXBException

Throws:

JAXBException

getListener

public Unmarshaller.Listener getListener()

Description copied from interface: Unmarshaller

Return Unmarshaller.Listener registered with this Unmarshaller.

Specified by:

getListener in interface Unmarshaller

Overrides:

getListener in class AbstractUnmarshallerImpl

Returns:

registered Unmarshaller.Listener or null if no Listener is registered with this Unmarshaller.

setListener

public void setListener(Unmarshaller.Listener listener)

Description copied from interface: Unmarshaller

Register unmarshal event callback Unmarshaller.Listener with this Unmarshaller.

There is only one Listener per Unmarshaller. Setting a Listener replaces the previous set Listener. One can unregister current Listener by setting listener to null.

Specified by:

setListener in interface Unmarshaller

Overrides:

setListener in class AbstractUnmarshallerImpl

Parameters:

listener - provides unmarshal event callbacks for this Unmarshaller

getContext

public UnmarshallingContext getContext()

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

close

public void close()
           throws IOException

Must be called from same thread which created the UnmarshallerImpl instance.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException