JAXB OSGI 4.0.9 · org.glassfish.jaxb.runtime.v2.runtime.unmarshaller.UnmarshallerImpl

Modifier and Type	Field and Description
private AttachmentUnmarshaller	attachmentUnmarshaller The attachment unmarshaller used to support MTOM and swaRef.
protected final JAXBContextImpl	context Owning `JAXBContext`
public final UnmarshallingContext	coordinator
private static final DefaultHandler	dummyHandler
private Unmarshaller.Listener	externalListener Unmarshaller.Listener
public static final String	FACTORY
private IDResolver	idResolver
private XMLReader	reader Hides jakarta.xml.bind.helpers.AbstractUnmarshallerImpl.reader.
private Schema	schema schema which will be used to validate during calls to unmarshal

Access	Constructor and Description
public	UnmarshallerImpl(JAXBContextImpl context, AssociationMap<XmlNode> assoc)

Method Summary

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

Inherited from jakarta.xml.bind.helpers.AbstractUnmarshallerImpl:: setAdapter setEventHandler unmarshal unmarshal unmarshal unmarshal unmarshal unmarshal

attachmentUnmarshaller	back to summary
private AttachmentUnmarshaller attachmentUnmarshaller The attachment unmarshaller used to support MTOM and swaRef.

context	back to summary
protected final JAXBContextImpl context Owning `JAXBContext`

coordinator	back to summary
public final UnmarshallingContext coordinator

dummyHandler	back to summary
private static final DefaultHandler dummyHandler

externalListener	back to summary
private Unmarshaller.Listener externalListener Unmarshaller.Listener

FACTORY	back to summary
public static final String FACTORY

idResolver	back to summary
private IDResolver idResolver

reader	back to summary
private XMLReader reader Hides jakarta.xml.bind.helpers.AbstractUnmarshallerImpl.reader.

schema	back to summary
private Schema schema schema which will be used to validate during calls to unmarshal

UnmarshallerImpl	back to summary
public UnmarshallerImpl(JAXBContextImpl context, AssociationMap<XmlNode> assoc)

Method Detail

close back to summary

close	back to summary
public void close() throws IOException Implements java.io.Closeable.close. Doc from java.io.Closeable.close. Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect. As noted in `AutoCloseable#close()`, cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the `Closeable` as closed, prior to throwing the `IOException`. Annotations @Override Exceptions IOException: if an I/O error occurs

public void close() throws IOException

Implements java.io.Closeable.close.

Doc from java.io.Closeable.close.

Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect.

As noted in AutoCloseable#close(), cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the Closeable as closed, prior to throwing the IOException.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs

createUnmarshalException	back to summary
public UnmarshalException createUnmarshalException(SAXException e) Overrides jakarta.xml.bind.helpers.AbstractUnmarshallerImpl.createUnmarshalException. Doc from jakarta.xml.bind.helpers.AbstractUnmarshallerImpl.createUnmarshalException. Creates an UnmarshalException from a SAXException. This is an 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 of SAXException and reduce those excessive wrapping. Annotations @Override

createUnmarshalException

back to summary

public UnmarshalException createUnmarshalException(SAXException e)

Overrides jakarta.xml.bind.helpers.AbstractUnmarshallerImpl.createUnmarshalException.

Doc from jakarta.xml.bind.helpers.AbstractUnmarshallerImpl.createUnmarshalException.

Creates an UnmarshalException from a SAXException. This is an 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 of SAXException and reduce those excessive wrapping.

Annotations

@Override

createUnmarshallerHandler back to summary

createUnmarshallerHandler	back to summary
public XmlVisitor createUnmarshallerHandler(InfosetScanner<XmlNode> scanner, boolean inplace, JaxBeanInfo<BeanT> expectedType) Creates and configures a new unmarshalling pipe line. Depending on the setting, we put a validator as a filter. Returns:XmlVisitor 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.

public XmlVisitor createUnmarshallerHandler(InfosetScanner<XmlNode> scanner, boolean inplace, JaxBeanInfo<BeanT> expectedType)

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

Returns:XmlVisitor: 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.

getAdapter back to summary

getAdapter	back to summary
public <A extends XmlAdapter<?, ?>> A getAdapter(Class<A> type) Overrides jakarta.xml.bind.helpers.AbstractUnmarshallerImpl.getAdapter. Implements jakarta.xml.bind.Unmarshaller.getAdapter. Doc from jakarta.xml.bind.Unmarshaller.getAdapter. Gets the adapter associated with the specified type. This is the reverse operation of the `setAdapter` method. Annotations @Override

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

Overrides jakarta.xml.bind.helpers.AbstractUnmarshallerImpl.getAdapter.

Implements jakarta.xml.bind.Unmarshaller.getAdapter.

Doc from jakarta.xml.bind.Unmarshaller.getAdapter.

Gets the adapter associated with the specified type. This is the reverse operation of the setAdapter method.

Annotations

@Override

getAttachmentUnmarshaller	back to summary
public AttachmentUnmarshaller getAttachmentUnmarshaller() Overrides jakarta.xml.bind.helpers.AbstractUnmarshallerImpl.getAttachmentUnmarshaller. Implements jakarta.xml.bind.Unmarshaller.getAttachmentUnmarshaller. Annotations @Override

getAttachmentUnmarshaller

back to summary

public AttachmentUnmarshaller getAttachmentUnmarshaller()

Overrides jakarta.xml.bind.helpers.AbstractUnmarshallerImpl.getAttachmentUnmarshaller.

Implements jakarta.xml.bind.Unmarshaller.getAttachmentUnmarshaller.

Annotations

@Override

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

getContext	back to summary
public UnmarshallingContext getContext()

getEventHandler	back to summary
public ValidationEventHandler getEventHandler() Overrides jakarta.xml.bind.helpers.AbstractUnmarshallerImpl.getEventHandler. Implements jakarta.xml.bind.Unmarshaller.getEventHandler. Doc from jakarta.xml.bind.helpers.AbstractUnmarshallerImpl.getEventHandler. Return the current event handler or the default event handler if one hasn't been set. Annotations @Override

getEventHandler

back to summary

public ValidationEventHandler getEventHandler()

Overrides jakarta.xml.bind.helpers.AbstractUnmarshallerImpl.getEventHandler.

Implements jakarta.xml.bind.Unmarshaller.getEventHandler.

Doc from jakarta.xml.bind.helpers.AbstractUnmarshallerImpl.getEventHandler.

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

Annotations

@Override

getListener back to summary

getListener	back to summary
public Unmarshaller.Listener getListener() Overrides jakarta.xml.bind.helpers.AbstractUnmarshallerImpl.getListener. Implements jakarta.xml.bind.Unmarshaller.getListener. Doc from jakarta.xml.bind.Unmarshaller.getListener. Return `Listener` registered with this `Unmarshaller`. Annotations @Override

public Unmarshaller.Listener getListener()

Overrides jakarta.xml.bind.helpers.AbstractUnmarshallerImpl.getListener.

Implements jakarta.xml.bind.Unmarshaller.getListener.

Doc from jakarta.xml.bind.Unmarshaller.getListener.

Return Listener registered with this Unmarshaller.

Annotations

@Override

getProperty	back to summary
public Object getProperty(String name) throws PropertyException Overrides jakarta.xml.bind.helpers.AbstractUnmarshallerImpl.getProperty. Implements jakarta.xml.bind.Unmarshaller.getProperty. Doc from jakarta.xml.bind.helpers.AbstractUnmarshallerImpl.getProperty. 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. Annotations @Override Exceptions PropertyException: Doc from jakarta.xml.bind.Unmarshaller.getProperty. when there is an error retrieving the given property or value property name

getProperty

back to summary

public Object getProperty(String name) throws PropertyException

Overrides jakarta.xml.bind.helpers.AbstractUnmarshallerImpl.getProperty.

Implements jakarta.xml.bind.Unmarshaller.getProperty.

Doc from jakarta.xml.bind.helpers.AbstractUnmarshallerImpl.getProperty.

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.

Annotations

@Override

Exceptions

PropertyException:

Doc from jakarta.xml.bind.Unmarshaller.getProperty.

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

getSchema back to summary

getSchema	back to summary
public Schema getSchema() Overrides jakarta.xml.bind.helpers.AbstractUnmarshallerImpl.getSchema. Implements jakarta.xml.bind.Unmarshaller.getSchema. Doc from jakarta.xml.bind.Unmarshaller.getSchema. 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. Annotations @Override

public Schema getSchema()

Overrides jakarta.xml.bind.helpers.AbstractUnmarshallerImpl.getSchema.

Implements jakarta.xml.bind.Unmarshaller.getSchema.

Doc from jakarta.xml.bind.Unmarshaller.getSchema.

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.

Annotations

@Override

getUnmarshallerHandler back to summary

getUnmarshallerHandler	back to summary
public UnmarshallerHandler getUnmarshallerHandler() Implements jakarta.xml.bind.Unmarshaller.getUnmarshallerHandler. Doc from jakarta.xml.bind.Unmarshaller.getUnmarshallerHandler. 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`. Annotations @Override

public UnmarshallerHandler getUnmarshallerHandler()

Implements jakarta.xml.bind.Unmarshaller.getUnmarshallerHandler.

Doc from jakarta.xml.bind.Unmarshaller.getUnmarshallerHandler.

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.

Annotations

@Override

getUnmarshallerHandler	back to summary
private SAXConnector getUnmarshallerHandler(boolean intern, JaxBeanInfo<BeanT> expectedType)

getXMLReader back to summary

getXMLReader	back to summary
protected XMLReader getXMLReader() throws JAXBException Overrides jakarta.xml.bind.helpers.AbstractUnmarshallerImpl.getXMLReader. 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. Annotations @Override

protected XMLReader getXMLReader() throws JAXBException

Overrides jakarta.xml.bind.helpers.AbstractUnmarshallerImpl.getXMLReader.

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.

Annotations

@Override

handleEvent back to summary

handleEvent	back to summary
public boolean handleEvent(ValidationEvent event) Implements jakarta.xml.bind.ValidationEventHandler.handleEvent. Default error handling behavior for `Unmarshaller`. Annotations @Override

public boolean handleEvent(ValidationEvent event)

Implements jakarta.xml.bind.ValidationEventHandler.handleEvent.

Default error handling behavior for Unmarshaller.

Annotations

@Override

handleStreamException	back to summary
private static JAXBException handleStreamException(XMLStreamException e)

hasEventHandler	back to summary
public boolean hasEventHandler() Returns true if an event handler is installed. The default handler ignores any errors, and for that this method returns false.

hasEventHandler

back to summary

public boolean hasEventHandler()

Returns true if an event handler is installed.

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

isValidating	back to summary
public boolean isValidating() Deprecated since 2.0 Annotations @Deprecated

needsInterning	back to summary
public static boolean needsInterning(XMLReader reader)

setAdapter back to summary

setAdapter	back to summary
public <A extends XmlAdapter<?, ?>> void setAdapter(Class<A> type, A adapter) Overrides jakarta.xml.bind.helpers.AbstractUnmarshallerImpl.setAdapter. Implements jakarta.xml.bind.Unmarshaller.setAdapter. Doc from jakarta.xml.bind.Unmarshaller.setAdapter. Associates a configured instance of `XmlAdapter` with this unmarshaller. Every unmarshaller internally maintains a `java.util.Map`<`Class`,`XmlAdapter`>, which it uses for unmarshalling classes whose fields/methods are annotated with `jakarta.xml.bind.annotation.adapters.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. Annotations @Override

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

Overrides jakarta.xml.bind.helpers.AbstractUnmarshallerImpl.setAdapter.

Implements jakarta.xml.bind.Unmarshaller.setAdapter.

Doc from jakarta.xml.bind.Unmarshaller.setAdapter.

Associates a configured instance of XmlAdapter with this unmarshaller.

Every unmarshaller internally maintains a java.util.Map<Class,XmlAdapter>, which it uses for unmarshalling classes whose fields/methods are annotated with jakarta.xml.bind.annotation.adapters.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.

Annotations

@Override

setAttachmentUnmarshaller back to summary

setAttachmentUnmarshaller	back to summary
public void setAttachmentUnmarshaller(AttachmentUnmarshaller au) Overrides jakarta.xml.bind.helpers.AbstractUnmarshallerImpl.setAttachmentUnmarshaller. Implements jakarta.xml.bind.Unmarshaller.setAttachmentUnmarshaller. Doc from jakarta.xml.bind.Unmarshaller.setAttachmentUnmarshaller. Associate a context that resolves cid's, content-id URIs, to binary data passed as attachments. Unmarshal time validation, enabled via `setSchema(Schema)`, must be supported even when unmarshaller is performing XOP processing. Annotations @Override

public void setAttachmentUnmarshaller(AttachmentUnmarshaller au)

Overrides jakarta.xml.bind.helpers.AbstractUnmarshallerImpl.setAttachmentUnmarshaller.

Implements jakarta.xml.bind.Unmarshaller.setAttachmentUnmarshaller.

Doc from jakarta.xml.bind.Unmarshaller.setAttachmentUnmarshaller.

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

Annotations

@Override

setListener back to summary

setListener	back to summary
public void setListener(Unmarshaller.Listener listener) Overrides jakarta.xml.bind.helpers.AbstractUnmarshallerImpl.setListener. Implements jakarta.xml.bind.Unmarshaller.setListener. Doc from jakarta.xml.bind.Unmarshaller.setListener. Register unmarshal event callback `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`. Annotations @Override

public void setListener(Unmarshaller.Listener listener)

Overrides jakarta.xml.bind.helpers.AbstractUnmarshallerImpl.setListener.

Implements jakarta.xml.bind.Unmarshaller.setListener.

Doc from jakarta.xml.bind.Unmarshaller.setListener.

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.

Annotations

@Override

setProperty	back to summary
public void setProperty(String name, Object value) throws PropertyException Overrides jakarta.xml.bind.helpers.AbstractUnmarshallerImpl.setProperty. Implements jakarta.xml.bind.Unmarshaller.setProperty. Doc from jakarta.xml.bind.helpers.AbstractUnmarshallerImpl.setProperty. 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. Annotations @Override Exceptions PropertyException: Doc from jakarta.xml.bind.Unmarshaller.setProperty. when there is an error processing the given property or value

setProperty

back to summary

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

Overrides jakarta.xml.bind.helpers.AbstractUnmarshallerImpl.setProperty.

Implements jakarta.xml.bind.Unmarshaller.setProperty.

Doc from jakarta.xml.bind.helpers.AbstractUnmarshallerImpl.setProperty.

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.

Annotations

@Override

Exceptions

PropertyException:

Doc from jakarta.xml.bind.Unmarshaller.setProperty.

when there is an error processing the given property or value

setSchema back to summary

setSchema	back to summary
public void setSchema(Schema schema) Overrides jakarta.xml.bind.helpers.AbstractUnmarshallerImpl.setSchema. Implements jakarta.xml.bind.Unmarshaller.setSchema. Doc from jakarta.xml.bind.Unmarshaller.setSchema. 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`. Annotations @Override

public void setSchema(Schema schema)

Overrides jakarta.xml.bind.helpers.AbstractUnmarshallerImpl.setSchema.

Implements jakarta.xml.bind.Unmarshaller.setSchema.

Doc from jakarta.xml.bind.Unmarshaller.setSchema.

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.

Annotations

@Override

setValidating	back to summary
public void setValidating(boolean validating) Deprecated since 2.0 Annotations @Deprecated

streamSourceToInputSource	back to summary
private static InputSource streamSourceToInputSource(StreamSource ss) Hides jakarta.xml.bind.helpers.AbstractUnmarshallerImpl.streamSourceToInputSource.

unmarshal	back to summary
protected Object unmarshal(XMLReader reader, InputSource source) throws JAXBException Implements abstract jakarta.xml.bind.helpers.AbstractUnmarshallerImpl.unmarshal. Doc from jakarta.xml.bind.helpers.AbstractUnmarshallerImpl.unmarshal. Unmarshals 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. Annotations @Override

unmarshal

back to summary

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

Implements abstract jakarta.xml.bind.helpers.AbstractUnmarshallerImpl.unmarshal.

Doc from jakarta.xml.bind.helpers.AbstractUnmarshallerImpl.unmarshal.

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

Annotations

@Override

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

unmarshal back to summary

unmarshal	back to summary
public <T> JAXBElement<T> unmarshal(Source source, Class<T> expectedType) throws JAXBException Overrides jakarta.xml.bind.helpers.AbstractUnmarshallerImpl.unmarshal. Implements jakarta.xml.bind.Unmarshaller.unmarshal. Doc from jakarta.xml.bind.Unmarshaller.unmarshal. 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 Annotations @Override Exceptions JAXBException: If any unexpected errors occur while unmarshalling

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

Overrides jakarta.xml.bind.helpers.AbstractUnmarshallerImpl.unmarshal.

Implements jakarta.xml.bind.Unmarshaller.unmarshal.

Doc from jakarta.xml.bind.Unmarshaller.unmarshal.

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

Annotations

@Override

Exceptions

JAXBException:: If any unexpected errors occur while unmarshalling

unmarshal back to summary

unmarshal	back to summary
public <T> JAXBElement<T> unmarshal(Node node, Class<T> expectedType) throws JAXBException Overrides jakarta.xml.bind.helpers.AbstractUnmarshallerImpl.unmarshal. Implements jakarta.xml.bind.Unmarshaller.unmarshal. Doc from jakarta.xml.bind.Unmarshaller.unmarshal. Unmarshal XML data by Jakarta XML Binding mapped `declaredType` and return the resulting content tree. Implements Unmarshal by Declared Type Annotations @Override Exceptions JAXBException: If any unexpected errors occur while unmarshalling

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

Overrides jakarta.xml.bind.helpers.AbstractUnmarshallerImpl.unmarshal.

Implements jakarta.xml.bind.Unmarshaller.unmarshal.

Doc from jakarta.xml.bind.Unmarshaller.unmarshal.

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

Implements Unmarshal by Declared Type

Annotations

@Override

Exceptions

JAXBException:: If any unexpected errors occur while unmarshalling

unmarshal	back to summary
public Object unmarshal(Node node) throws JAXBException Implements jakarta.xml.bind.Unmarshaller.unmarshal. Doc from jakarta.xml.bind.Unmarshaller.unmarshal. Unmarshal global XML data from the specified DOM tree and return the resulting content tree. Implements Unmarshal Global Root Element. Annotations @Override Exceptions JAXBException: If any unexpected errors occur while unmarshalling

unmarshal

back to summary

public Object unmarshal(Node node) throws JAXBException

Implements jakarta.xml.bind.Unmarshaller.unmarshal.

Doc from jakarta.xml.bind.Unmarshaller.unmarshal.

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

Implements Unmarshal Global Root Element.

Annotations

@Override

Exceptions

JAXBException:: If any unexpected errors occur while unmarshalling

unmarshal	back to summary
public Object unmarshal(SAXSource source) throws JAXBException Hides jakarta.xml.bind.helpers.AbstractUnmarshallerImpl.unmarshal. Deprecated Annotations @Deprecated

unmarshal

back to summary

public Object unmarshal(SAXSource source) throws JAXBException

Hides jakarta.xml.bind.helpers.AbstractUnmarshallerImpl.unmarshal.

Deprecated

Annotations

@Deprecated

unmarshal back to summary

unmarshal	back to summary
public Object unmarshal(XMLStreamReader reader) throws JAXBException Overrides jakarta.xml.bind.helpers.AbstractUnmarshallerImpl.unmarshal. Implements jakarta.xml.bind.Unmarshaller.unmarshal. Doc from jakarta.xml.bind.Unmarshaller.unmarshal. 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. Annotations @Override Exceptions JAXBException: If any unexpected errors occur while unmarshalling

public Object unmarshal(XMLStreamReader reader) throws JAXBException

Overrides jakarta.xml.bind.helpers.AbstractUnmarshallerImpl.unmarshal.

Implements jakarta.xml.bind.Unmarshaller.unmarshal.

Doc from jakarta.xml.bind.Unmarshaller.unmarshal.

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.

Annotations

@Override

Exceptions

JAXBException:: If any unexpected errors occur while unmarshalling

unmarshal back to summary

unmarshal	back to summary
public <T> JAXBElement<T> unmarshal(XMLStreamReader reader, Class<T> expectedType) throws JAXBException Overrides jakarta.xml.bind.helpers.AbstractUnmarshallerImpl.unmarshal. Implements jakarta.xml.bind.Unmarshaller.unmarshal. Doc from jakarta.xml.bind.Unmarshaller.unmarshal. 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. Annotations @Override Exceptions JAXBException: If any unexpected errors occur while unmarshalling

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

Overrides jakarta.xml.bind.helpers.AbstractUnmarshallerImpl.unmarshal.

Implements jakarta.xml.bind.Unmarshaller.unmarshal.

Doc from jakarta.xml.bind.Unmarshaller.unmarshal.

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

This method implements unmarshal by declaredType.

Annotations

@Override

Exceptions

JAXBException:: If any unexpected errors occur while unmarshalling

unmarshal back to summary

unmarshal	back to summary
public <T> JAXBElement<T> unmarshal(XMLEventReader reader, Class<T> expectedType) throws JAXBException Overrides jakarta.xml.bind.helpers.AbstractUnmarshallerImpl.unmarshal. Implements jakarta.xml.bind.Unmarshaller.unmarshal. Doc from jakarta.xml.bind.Unmarshaller.unmarshal. 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. Annotations @Override Exceptions JAXBException: If any unexpected errors occur while unmarshalling

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

Overrides jakarta.xml.bind.helpers.AbstractUnmarshallerImpl.unmarshal.

Implements jakarta.xml.bind.Unmarshaller.unmarshal.

Doc from jakarta.xml.bind.Unmarshaller.unmarshal.

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

This method implements unmarshal by declaredType.

Annotations

@Override

Exceptions

JAXBException:: If any unexpected errors occur while unmarshalling

unmarshal back to summary

unmarshal	back to summary
public Object unmarshal(XMLEventReader reader) throws JAXBException Overrides jakarta.xml.bind.helpers.AbstractUnmarshallerImpl.unmarshal. Implements jakarta.xml.bind.Unmarshaller.unmarshal. Doc from jakarta.xml.bind.Unmarshaller.unmarshal. 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. Annotations @Override Exceptions JAXBException: If any unexpected errors occur while unmarshalling

public Object unmarshal(XMLEventReader reader) throws JAXBException

Overrides jakarta.xml.bind.helpers.AbstractUnmarshallerImpl.unmarshal.

Implements jakarta.xml.bind.Unmarshaller.unmarshal.

Doc from jakarta.xml.bind.Unmarshaller.unmarshal.

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

This method is an Unmarshal Global Root method.

Annotations

@Override

Exceptions

JAXBException:: If any unexpected errors occur while unmarshalling

unmarshal0	back to summary
private Object unmarshal0(XMLReader reader, InputSource source, JaxBeanInfo<BeanT> expectedType) throws JAXBException

unmarshal0	back to summary
public Object unmarshal0(Source source, JaxBeanInfo<BeanT> expectedType) throws JAXBException

unmarshal0	back to summary
public Object unmarshal0(Node node, JaxBeanInfo<BeanT> expectedType) throws JAXBException

unmarshal0	back to summary
public Object unmarshal0(XMLStreamReader reader, JaxBeanInfo<BeanT> expectedType) throws JAXBException

unmarshal0	back to summary
private Object unmarshal0(XMLEventReader reader, JaxBeanInfo<BeanT> expectedType) throws JAXBException

unmarshal0	back to summary
public Object unmarshal0(InputStream input, JaxBeanInfo<BeanT> expectedType) throws JAXBException

public final Class UnmarshallerImpl

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail