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)
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)
AttachmentUnmarshaller	getAttachmentUnmarshaller()
<T> JaxBeanInfo<T>	getBeanInfo(Class<T> clazz)
UnmarshallingContext	getContext()
ValidationEventHandler	getEventHandler()
Unmarshaller.Listener	getListener()
Object	getProperty(String name)
Schema	getSchema()
UnmarshallerHandler	getUnmarshallerHandler()
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)
void	setAttachmentUnmarshaller(AttachmentUnmarshaller au)
void	setListener(Unmarshaller.Listener listener)
void	setProperty(String name, Object value)
void	setSchema(Schema schema)
void	setValidating(boolean validating)	Deprecated. since 2.0
Object	unmarshal(XMLEventReader reader)
<T> JAXBElement<T>	unmarshal(XMLEventReader reader, Class<T> expectedType)
Object	unmarshal(XMLStreamReader reader)
<T> JAXBElement<T>	unmarshal(XMLStreamReader reader, Class<T> expectedType)
Object	unmarshal(SAXSource source)	Deprecated.
<T> JAXBElement<T>	unmarshal(Source source, Class<T> expectedType)
Object	unmarshal(Node node)
<T> JAXBElement<T>	unmarshal(Node node, Class<T> expectedType)
protected Object	unmarshal(XMLReader reader, InputSource source)
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()

Specified by:

getUnmarshallerHandler in interface Unmarshaller

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

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

Specified by:

unmarshal in interface Unmarshaller

Overrides:

unmarshal in class AbstractUnmarshallerImpl

Throws:

JAXBException

unmarshal0

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

Throws:

JAXBException

getEventHandler

public ValidationEventHandler getEventHandler()

Specified by:

getEventHandler in interface Unmarshaller

Overrides:

getEventHandler in class AbstractUnmarshallerImpl

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

Specified by:

unmarshal in interface Unmarshaller

Overrides:

unmarshal in class AbstractUnmarshallerImpl

Throws:

JAXBException

unmarshal

public Object unmarshal(Node node)
                 throws JAXBException

Specified by:

unmarshal in interface Unmarshaller

Throws:

JAXBException

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

Specified by:

unmarshal in interface Unmarshaller

Overrides:

unmarshal in class AbstractUnmarshallerImpl

Throws:

JAXBException

unmarshal

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

Specified by:

unmarshal in interface Unmarshaller

Overrides:

unmarshal in class AbstractUnmarshallerImpl

Throws:

JAXBException

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

Specified by:

unmarshal in interface Unmarshaller

Overrides:

unmarshal in class AbstractUnmarshallerImpl

Throws:

JAXBException

unmarshal

public Object unmarshal(XMLEventReader reader)
                 throws JAXBException

Specified by:

unmarshal in interface Unmarshaller

Overrides:

unmarshal in class AbstractUnmarshallerImpl

Throws:

JAXBException

unmarshal0

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

Throws:

JAXBException

getProperty

public Object getProperty(String name)
                   throws PropertyException

Specified by:

getProperty in interface Unmarshaller

Overrides:

getProperty in class AbstractUnmarshallerImpl

Throws:

PropertyException

setProperty

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

Specified by:

setProperty in interface Unmarshaller

Overrides:

setProperty in class AbstractUnmarshallerImpl

Throws:

PropertyException

setSchema

public void setSchema(Schema schema)

Specified by:

setSchema in interface Unmarshaller

Overrides:

setSchema in class AbstractUnmarshallerImpl

getSchema

public Schema getSchema()

Specified by:

getSchema in interface Unmarshaller

Overrides:

getSchema in class AbstractUnmarshallerImpl

getAttachmentUnmarshaller

public AttachmentUnmarshaller getAttachmentUnmarshaller()

Specified by:

getAttachmentUnmarshaller in interface Unmarshaller

Overrides:

getAttachmentUnmarshaller in class AbstractUnmarshallerImpl

setAttachmentUnmarshaller

public void setAttachmentUnmarshaller(AttachmentUnmarshaller au)

Specified by:

setAttachmentUnmarshaller in interface Unmarshaller

Overrides:

setAttachmentUnmarshaller in class AbstractUnmarshallerImpl

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)

Specified by:

setAdapter in interface Unmarshaller

Overrides:

setAdapter in class AbstractUnmarshallerImpl

getAdapter

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

Specified by:

getAdapter in interface Unmarshaller

Overrides:

getAdapter in class AbstractUnmarshallerImpl

createUnmarshalException

public UnmarshalException createUnmarshalException(SAXException e)

Overrides:

createUnmarshalException in class AbstractUnmarshallerImpl

handleEvent

public boolean handleEvent(ValidationEvent event)

Default error handling behavior for Unmarshaller.

Specified by:

handleEvent in interface ValidationEventHandler

getBeanInfo

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

Throws:

JAXBException

getListener

public Unmarshaller.Listener getListener()

Specified by:

getListener in interface Unmarshaller

Overrides:

getListener in class AbstractUnmarshallerImpl

setListener

public void setListener(Unmarshaller.Listener listener)

Specified by:

setListener in interface Unmarshaller

Overrides:

setListener in class AbstractUnmarshallerImpl

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