EE4J 10.0.0 · jakarta.xml.bind.Unmarshaller

The Unmarshaller class governs the process of deserializing XML data into newly created Java content trees, optionally validating the XML data as it is unmarshalled. It provides an overloading of unmarshal methods for many different input kinds.

Unmarshalling from a File:

      JAXBContext jc = JAXBContext.newInstance( "com.acme.foo" );
      Unmarshaller u = jc.createUnmarshaller();
      Object o = u.unmarshal( new File( "nosferatu.xml" ) );

Unmarshalling from an InputStream:

      InputStream is = new FileInputStream( "nosferatu.xml" );
      JAXBContext jc = JAXBContext.newInstance( "com.acme.foo" );
      Unmarshaller u = jc.createUnmarshaller();
      Object o = u.unmarshal( is );

Unmarshalling from a URL:

      JAXBContext jc = JAXBContext.newInstance( "com.acme.foo" );
      Unmarshaller u = jc.createUnmarshaller();
      URL url = new URL( "http://beaker.east/nosferatu.xml" );
      Object o = u.unmarshal( url );

Unmarshalling from a StringBuffer using a javax.xml.transform.stream.StreamSource:

JAXBContext jc = JAXBContext.newInstance( "com.acme.foo" );
      Unmarshaller u = jc.createUnmarshaller();
      StringBuffer xmlStr = new StringBuffer( "<?xml version="1.0"?>..." );
      Object o = u.unmarshal( new StreamSource( new StringReader( xmlStr.toString() ) ) );

Unmarshalling from a org.w3c.dom.Node:

      JAXBContext jc = JAXBContext.newInstance( "com.acme.foo" );
      Unmarshaller u = jc.createUnmarshaller();

      DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
      dbf.setNamespaceAware(true);
      DocumentBuilder db = dbf.newDocumentBuilder();
      Document doc = db.parse(new File( "nosferatu.xml"));

      Object o = u.unmarshal( doc );

Unmarshalling from a javax.xml.transform.sax.SAXSource using a client specified validating SAX2.0 parser:

      // configure a validating SAX2.0 parser (Xerces2)
      static final String JAXP_SCHEMA_LANGUAGE =
          "http://java.sun.com/xml/jaxp/properties/schemaLanguage";
      static final String JAXP_SCHEMA_LOCATION =
          "http://java.sun.com/xml/jaxp/properties/schemaSource";
      static final String W3C_XML_SCHEMA =
          "http://www.w3.org/2001/XMLSchema";

      System.setProperty( "javax.xml.parsers.SAXParserFactory",
                          "org.apache.xerces.jaxp.SAXParserFactoryImpl" );

      SAXParserFactory spf = SAXParserFactory.newInstance();
      spf.setNamespaceAware(true);
      spf.setValidating(true);
      SAXParser saxParser = spf.newSAXParser();

      try {
          saxParser.setProperty(JAXP_SCHEMA_LANGUAGE, W3C_XML_SCHEMA);
          saxParser.setProperty(JAXP_SCHEMA_LOCATION, "http://....");
      } catch (SAXNotRecognizedException x) {
          // exception handling omitted
      }

      XMLReader xmlReader = saxParser.getXMLReader();
      SAXSource source =
          new SAXSource( xmlReader, new InputSource( "http://..." ) );

      // Setup Jakarta XML Binding to unmarshal
      JAXBContext jc = JAXBContext.newInstance( "com.acme.foo" );
      Unmarshaller u = jc.createUnmarshaller();
      ValidationEventCollector vec = new ValidationEventCollector();
      u.setEventHandler( vec );

      // turn off the Jakarta XML Binding provider's default validation mechanism to
      // avoid duplicate validation
      u.setValidating( false )

      // unmarshal
      Object o = u.unmarshal( source );

      // check for events
      if( vec.hasEvents() ) {
         // iterate over events
      }

Unmarshalling from a StAX XMLStreamReader:

      JAXBContext jc = JAXBContext.newInstance( "com.acme.foo" );
      Unmarshaller u = jc.createUnmarshaller();

      javax.xml.stream.XMLStreamReader xmlStreamReader =
          javax.xml.stream.XMLInputFactory().newInstance().createXMLStreamReader( ... );

      Object o = u.unmarshal( xmlStreamReader );

Unmarshalling from a StAX XMLEventReader:

      JAXBContext jc = JAXBContext.newInstance( "com.acme.foo" );
      Unmarshaller u = jc.createUnmarshaller();

      javax.xml.stream.XMLEventReader xmlEventReader =
          javax.xml.stream.XMLInputFactory().newInstance().createXMLEventReader( ... );

      Object o = u.unmarshal( xmlEventReader );

Unmarshalling XML Data

Unmarshalling can deserialize XML data that represents either an entire XML document or a subtree of an XML document. Typically, it is sufficient to use the unmarshalling methods described by Unmarshal root element that is declared globally. These unmarshal methods utilize JAXBContext's mapping of global XML element declarations and type definitions to Jakarta XML Binding mapped classes to initiate the unmarshalling of the root element of XML data. When the JAXBContext's mappings are not sufficient to unmarshal the root element of XML data, the application can assist the unmarshalling process by using the unmarshal by declaredType methods. These methods are useful for unmarshalling XML data where the root element corresponds to a local element declaration in the schema.

An unmarshal method never returns null. If the unmarshal process is unable to unmarshal the root of XML content to a Jakarta XML Binding mapped object, a fatal error is reported that terminates processing by throwing JAXBException.

Unmarshal a root element that is globally declared

The unmarshal methods that do not have an declaredType parameter use JAXBContext to unmarshal the root element of an XML data. The JAXBContext instance is the one that was used to create this Unmarshaller. The JAXBContext instance maintains a mapping of globally declared XML element and type definition names to Jakarta XML Binding mapped classes. The unmarshal method checks if JAXBContext has a mapping from the root element's XML name and/or @xsi:type to a Jakarta XML Binding mapped class. If it does, it umarshalls the XML data using the appropriate Jakarta XML Binding mapped class. Note that when the root element name is unknown and the root element has an @xsi:type, the XML data is unmarshalled using that Jakarta XML Binding mapped class as the value of a JAXBElement. When the JAXBContext object does not have a mapping for the root element's name nor its @xsi:type, if it exists, then the unmarshal operation will abort immediately by throwing a UnmarshalException. This exception scenario can be worked around by using the unmarshal by declaredType methods described in the next subsection.

Unmarshal by Declared Type

The unmarshal methods with a declaredType parameter enable an application to deserialize a root element of XML data, even when there is no mapping in JAXBContext of the root element's XML name. The unmarshaller unmarshals the root element using the application provided mapping specified as the declaredType parameter. Note that even when the root element's element name is mapped by JAXBContext, the declaredType parameter overrides that mapping for deserializing the root element when using these unmarshal methods. Additionally, when the root element of XML data has an xsi:type attribute and that attribute's value references a type definition that is mapped to a Jakarta XML Binding mapped class by JAXBContext, that the root element's xsi:type attribute takes precedence over the unmarshal methods declaredType parameter. These methods always return a JAXBElement<declaredType> instance. The table below shows how the properties of the returned JAXBElement instance are set.
Unmarshal By Declared Type returned JAXBElement

JAXBElement Property Value

name xml element name

value instanceof declaredType

declaredType unmarshal method declaredType parameter

scope null (actual scope is unknown)

Unmarshal By Declared Type returned JAXBElement
JAXBElement Property	Value
value	`instanceof declaredType`
declaredType	unmarshal method `declaredType` parameter
scope	`null` (actual scope is unknown)

The following is an example of unmarshal by declaredType method.

Unmarshal by declaredType from a org.w3c.dom.Node:

Schema fragment for example
      <xs:schema>
         <xs:complexType name="FooType">...<\xs:complexType>
         <!-- global element declaration "PurchaseOrder" -->
         <xs:element name="PurchaseOrder">
             <xs:complexType>
                <xs:sequence>
                   <!-- local element declaration "foo" -->
                   <xs:element name="foo" type="FooType"/>
                   ...
                </xs:sequence>
             </xs:complexType>
         </xs:element>
      </xs:schema>

      JAXBContext jc = JAXBContext.newInstance( "com.acme.foo" );
      Unmarshaller u = jc.createUnmarshaller();

      DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
      dbf.setNamespaceAware(true);
      DocumentBuilder db = dbf.newDocumentBuilder();
      Document doc = db.parse(new File( "nosferatu.xml"));
      Element  fooSubtree = ...; // traverse DOM till reach xml element foo, constrained by a
                                 // local element declaration in schema.

      // FooType is the Jakarta XML Binding mapping of the type of local element declaration foo.
      JAXBElement<FooType> foo = u.unmarshal( fooSubtree, FooType.class);

Support for SAX2.0 Compliant Parsers

A client application has the ability to select the SAX2.0 compliant parser of their choice. If a SAX parser is not selected, then the Jakarta XML Binding Provider's default parser will be used. Even though the Jakarta XML Binding Provider's default parser is not required to be SAX2.0 compliant, all providers are required to allow a client application to specify their own SAX2.0 parser. Some providers may require the client application to specify the SAX2.0 parser at schema compile time. See unmarshal(Source) for more detail.

Validation and Well-Formedness

A client application can enable or disable JAXP validation mechanism via the setSchema(javax.xml.validation.Schema) API. Sophisticated clients can specify their own validating SAX 2.0 compliant parser and bypass the JAXP validation mechanism using the unmarshal(Source) API.
Since unmarshalling invalid XML content is defined in Jakarta XML Binding, the Unmarshaller default validation event handler was made more lenient than in JAXB 1.0. When schema-derived code generated by JAXB 1.0 binding compiler is registered with JAXBContext, the default unmarshal validation handler is jakarta.xml.bind.helpers.DefaultValidationEventHandler and it terminates the marshal operation after encountering either a fatal error or an error. For a Jakarta XML Binding client application, there is no explicitly defined default validation handler and the default event handling only terminates the unmarshal operation after encountering a fatal error.

Supported Properties

There currently are not any properties required to be supported by all Jakarta XML Binding Providers on Unmarshaller. However, some providers may support their own set of provider specific properties.

Unmarshal Event Callbacks

The Unmarshaller provides two styles of callback mechanisms that allow application specific processing during key points in the unmarshalling process. In 'class defined' event callbacks, application specific code placed in Jakarta XML Binding mapped classes is triggered during unmarshalling. 'External listeners' allow for centralized processing of unmarshal events in one callback method rather than by type event callbacks.
'Class defined' event callback methods allow any Jakarta XML Binding mapped class to specify its own specific callback methods by defining methods with the following method signature:
  // This method is called immediately after the object is created and before the unmarshalling of this
  // object begins. The callback provides an opportunity to initialize JavaBean properties prior to unmarshalling.
  void beforeUnmarshal(Unmarshaller, Object parent);

  //This method is called after all the properties (except IDREF) are unmarshalled for this object,
  //but before this object is set to the parent object.
  void afterUnmarshal(Unmarshaller, Object parent);
The class defined callback methods should be used when the callback method requires access to non-public methods and/or fields of the class.
The external listener callback mechanism enables the registration of a Listener instance with an Unmarshaller#setListener(Listener). The external listener receives all callback events, allowing for more centralized processing than per class defined callback methods. The external listener receives events when unmarshalling process is marshalling to a Jakarta XML Binding element or to Jakarta XML Binding mapped class.
The 'class defined' and external listener event callback methods are independent of each other, both can be called for one event. The invocation ordering when both listener callback methods exist is defined in Listener#beforeUnmarshal(Object, Object) and Listener#afterUnmarshal(Object, Object).
An event callback method throwing an exception terminates the current unmarshal process.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public abstract static class	Unmarshaller.Listener Register an instance of an implementation of this class with `Unmarshaller` to externally listen for unmarshal events.

Method Summary

Modifier and Type	Method and Description
public < the type of the adapter A extends XmlAdapter<?, ?>> A	Returns: The adapter associated with the specified type. getAdapter(Class<A> The type of the adapter. The specified instance will be used when `jakarta.xml.bind.annotation.adapters.XmlJavaTypeAdapter#value()` refers to this type. type) Gets the adapter associated with the specified type.
public AttachmentUnmarshaller	getAttachmentUnmarshaller()
public ValidationEventHandler	Returns: the current ValidationEventHandler or the default event handler if it hasn't been set getEventHandler() Return the current event handler or the default event handler if one hasn't been set.
public Unmarshaller.Listener	Returns: registered `Listener` or `null` if no Listener is registered with this Unmarshaller. getListener() Return `Listener` registered with this `Unmarshaller`.
public Object	Returns: the value of the requested property getProperty(String the name of the property to retrieve name) Get the particular property in the underlying implementation of `Unmarshaller`.
public Schema	Returns: the Schema object being used to perform unmarshal-time validation or null if not present getSchema() Get the JAXP `Schema` object being used to perform unmarshal-time validation.
public UnmarshallerHandler	Returns: the unmarshaller handler object getUnmarshallerHandler() Get an unmarshaller handler object that can be used as a component in an XML pipeline.
public < the type of `XmlAdapter` A extends XmlAdapter<?, ?>> void	setAdapter(A the configured instance of `XmlAdapter` adapter) Associates a configured instance of `XmlAdapter` with this unmarshaller.
public < the type of the adapter A extends XmlAdapter<?, ?>> void	setAdapter(Class<A> The type of the adapter. The specified instance will be used when `jakarta.xml.bind.annotation.adapters.XmlJavaTypeAdapter#value()` refers to this type. type, A The instance of the adapter to be used. If null, it will un-register the current adapter set for this type. adapter) Associates a configured instance of `XmlAdapter` with this unmarshaller.
public void	setAttachmentUnmarshaller(AttachmentUnmarshaller the attachment unmarshaller to be set au) Associate a context that resolves cid's, content-id URIs, to binary data passed as attachments.
public void	setEventHandler(ValidationEventHandler the validation event handler handler) Allow an application to register a `ValidationEventHandler`.
public void	setListener(Unmarshaller.Listener provides unmarshal event callbacks for this `Unmarshaller` listener) Register unmarshal event callback `Listener` with this `Unmarshaller`.
public void	setProperty(String 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. name, Object the value of the property to be set value) Set the particular property in the underlying implementation of `Unmarshaller`.
public void	setSchema(Schema Schema object to validate unmarshal operations against or null to disable validation schema) Specify the JAXP `Schema` object that should be used to validate subsequent unmarshal operations against.
public Object	Returns: the newly created root object of the java content tree unmarshal(File the file to unmarshal XML data from f) Unmarshal XML data from the specified file and return the resulting content tree.
public Object	Returns: the newly created root object of the java content tree unmarshal(InputStream the InputStream to unmarshal XML data from is) Unmarshal XML data from the specified InputStream and return the resulting content tree.
public Object	Returns: the newly created root object of the java content tree unmarshal(Reader the Reader to unmarshal XML data from reader) Unmarshal XML data from the specified Reader and return the resulting content tree.
public Object	Returns: the newly created root object of the java content tree unmarshal(URL the url to unmarshal XML data from url) Unmarshal XML data from the specified URL and return the resulting content tree.
public Object	Returns: the newly created root object of the java content tree unmarshal(InputSource the input source to unmarshal XML data from source) Unmarshal XML data from the specified SAX InputSource and return the resulting content tree.
public Object	Returns: the newly created root object of the java content tree unmarshal(Node the document/element to unmarshal XML data from. The caller must support at least Document and Element. node) Unmarshal global XML data from the specified DOM tree and return the resulting content tree.
public < the XML Binding mapped class T> JAXBElement<T>	Returns: JAXBElement representation of `node` unmarshal(Node the document/element to unmarshal XML data from. The caller must support at least Document and Element. node, Class<T> appropriate Jakarta XML Binding mapped class to hold `node`'s XML data. declaredType) Unmarshal XML data by Jakarta XML Binding mapped `declaredType` and return the resulting content tree.
public Object	Returns: the newly created root object of the java content tree unmarshal(Source the XML Source to unmarshal XML data from (providers are only required to support SAXSource, DOMSource, and StreamSource) source) Unmarshal XML data from the specified XML Source and return the resulting content tree.
public < the XML Binding mapped class T> JAXBElement<T>	Returns: Java content rooted by JAXBElement unmarshal(Source the XML Source to unmarshal XML data from (providers are only required to support SAXSource, DOMSource, and StreamSource) source, Class<T> appropriate Jakarta XML Binding mapped class to hold `source`'s xml root element declaredType) Unmarshal XML data from the specified XML Source by `declaredType` and return the resulting content tree.
public Object	Returns: the newly created root object of the java content tree. unmarshal(XMLStreamReader The parser to be read. reader) Unmarshal XML data from the specified pull parser and return the resulting content tree.
public < the XML Binding mapped class T> JAXBElement<T>	Returns: content tree rooted by JAXBElement representation unmarshal(XMLStreamReader The parser to be read. reader, Class<T> appropriate Jakarta XML Binding mapped class to hold `reader`'s START_ELEMENT XML data. declaredType) Unmarshal root element to Jakarta XML Binding mapped `declaredType` and return the resulting content tree.
public Object	Returns: the newly created root object of the java content tree. unmarshal(XMLEventReader The parser to be read. reader) Unmarshal XML data from the specified pull parser and return the resulting content tree.
public < the XML Binding mapped class T> JAXBElement<T>	Returns: content tree rooted by JAXBElement representation unmarshal(XMLEventReader The parser to be read. reader, Class<T> appropriate Jakarta XML Binding mapped class to hold `reader`'s START_ELEMENT XML data. declaredType) Unmarshal root element to Jakarta XML Binding mapped `declaredType` and return the resulting content tree.

Method Detail

getAdapter back to summary

getAdapter	back to summary
public <A extends XmlAdapter<?, ?>> A getAdapter(Class<A> type) Gets the adapter associated with the specified type. This is the reverse operation of the `setAdapter` method. Parameters <A> the type of the adapter type:Class<A> The type of the adapter. The specified instance will be used when `jakarta.xml.bind.annotation.adapters.XmlJavaTypeAdapter#value()` refers to this type. Returns:A The adapter associated with the specified type. Exceptions IllegalArgumentException: if the type parameter is null. UnsupportedOperationException: if invoked agains a JAXB 1.0 implementation. Since 1.6, JAXB 2.0

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

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

Parameters

<A>: the type of the adapter
type:Class<A>: The type of the adapter. The specified instance will be used when jakarta.xml.bind.annotation.adapters.XmlJavaTypeAdapter#value() refers to this type.

Returns:A

The adapter associated with the specified type.

Exceptions

IllegalArgumentException:: if the type parameter is null.
UnsupportedOperationException:: if invoked agains a JAXB 1.0 implementation.

Since

1.6, JAXB 2.0

getAttachmentUnmarshaller	back to summary
public AttachmentUnmarshaller getAttachmentUnmarshaller()

getEventHandler	back to summary
public ValidationEventHandler getEventHandler() throws JAXBException Return the current event handler or the default event handler if one hasn't been set. Returns:ValidationEventHandler the current ValidationEventHandler or the default event handler if it hasn't been set Exceptions JAXBException: if an error was encountered while getting the current event handler

getEventHandler

back to summary

public ValidationEventHandler getEventHandler() throws JAXBException

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

Returns:ValidationEventHandler

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

Exceptions

JAXBException:: if an error was encountered while getting the current event handler

getListener back to summary

getListener	back to summary
public Unmarshaller.Listener getListener() Return `Listener` registered with this `Unmarshaller`. Returns:Unmarshaller.Listener registered `Listener` or `null` if no Listener is registered with this Unmarshaller. Since 1.6, JAXB 2.0

public Unmarshaller.Listener getListener()

Return Listener registered with this Unmarshaller.

Returns:Unmarshaller.Listener: registered Listener or null if no Listener is registered with this Unmarshaller.
Since: 1.6, JAXB 2.0

getProperty back to summary

getProperty	back to summary
public Object getProperty(String name) throws PropertyException Get the particular property in the underlying implementation of `Unmarshaller`. This method can only be used to get one of the standard Jakarta XML Binding defined properties above or a provider specific property. Attempting to get an undefined property will result in a PropertyException being thrown. See Supported Properties. Parameters name:String the name of the property to retrieve Returns:Object the value of the requested property Exceptions PropertyException: when there is an error retrieving the given property or value property name IllegalArgumentException: If the name parameter is null

public Object getProperty(String name) throws PropertyException

Get the particular property in the underlying implementation of Unmarshaller. This method can only be used to get one of the standard Jakarta XML Binding defined properties above or a provider specific property. Attempting to get an undefined property will result in a PropertyException being thrown. See Supported Properties.

Parameters

name:String: the name of the property to retrieve

Returns:Object

the value of the requested property

Exceptions

PropertyException:: when there is an error retrieving the given property or value property name
IllegalArgumentException:: If the name parameter is null

getSchema back to summary

getSchema	back to summary
public Schema 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. Returns:Schema the Schema object being used to perform unmarshal-time validation or null if not present Exceptions UnsupportedOperationException: could be thrown if this method is invoked on an Unmarshaller created from a JAXBContext referencing JAXB 1.0 mapped classes Since 1.6, JAXB 2.0

public Schema 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.

Returns:Schema

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

Exceptions

UnsupportedOperationException:: could be thrown if this method is invoked on an Unmarshaller created from a JAXBContext referencing JAXB 1.0 mapped classes

Since

1.6, JAXB 2.0

getUnmarshallerHandler back to summary

getUnmarshallerHandler	back to summary
public UnmarshallerHandler 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`. Returns:UnmarshallerHandler the unmarshaller handler object See Also `UnmarshallerHandler`

public UnmarshallerHandler 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.

Returns:UnmarshallerHandler: the unmarshaller handler object
See Also: UnmarshallerHandler

setAdapter back to summary

setAdapter	back to summary
public <A extends XmlAdapter<?, ?>> void setAdapter(A adapter) Associates a configured instance of `XmlAdapter` with this unmarshaller. This is a convenience method that invokes `setAdapter(adapter.getClass(),adapter);`. Parameters <A> the type of `XmlAdapter` adapter:A the configured instance of `XmlAdapter` Exceptions IllegalArgumentException: if the adapter parameter is null. UnsupportedOperationException: if invoked agains a JAXB 1.0 implementation. Since 1.6, JAXB 2.0 See Also `setAdapter(Class, XmlAdapter)`

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

Associates a configured instance of XmlAdapter with this unmarshaller.

This is a convenience method that invokes setAdapter(adapter.getClass(),adapter);.

Parameters

<A>: the type of XmlAdapter
adapter:A: the configured instance of XmlAdapter

Exceptions

IllegalArgumentException:: if the adapter parameter is null.
UnsupportedOperationException:: if invoked agains a JAXB 1.0 implementation.

Since

1.6, JAXB 2.0

See Also

setAdapter(Class, XmlAdapter)

setAdapter back to summary

setAdapter	back to summary
public <A extends XmlAdapter<?, ?>> void setAdapter(Class<A> type, A adapter) 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. Parameters <A> the type of the adapter type:Class<A> The type of the adapter. The specified instance will be used when `jakarta.xml.bind.annotation.adapters.XmlJavaTypeAdapter#value()` refers to this type. adapter:A The instance of the adapter to be used. If null, it will un-register the current adapter set for this type. Exceptions IllegalArgumentException: if the type parameter is null. UnsupportedOperationException: if invoked agains a JAXB 1.0 implementation. Since 1.6, JAXB 2.0

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

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.

Parameters

<A>: the type of the adapter
type:Class<A>: The type of the adapter. The specified instance will be used when jakarta.xml.bind.annotation.adapters.XmlJavaTypeAdapter#value() refers to this type.
adapter:A: The instance of the adapter to be used. If null, it will un-register the current adapter set for this type.

Exceptions

IllegalArgumentException:: if the type parameter is null.
UnsupportedOperationException:: if invoked agains a JAXB 1.0 implementation.

Since

1.6, JAXB 2.0

setAttachmentUnmarshaller back to summary

setAttachmentUnmarshaller	back to summary
public void setAttachmentUnmarshaller(AttachmentUnmarshaller au) 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. Parameters au:AttachmentUnmarshaller the attachment unmarshaller to be set Exceptions IllegalStateException: if attempt to concurrently call this method during a unmarshal operation.

public void setAttachmentUnmarshaller(AttachmentUnmarshaller au)

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.

Parameters

au:AttachmentUnmarshaller: the attachment unmarshaller to be set

Exceptions

IllegalStateException:: if attempt to concurrently call this method during a unmarshal operation.

setEventHandler back to summary

setEventHandler	back to summary
public void setEventHandler(ValidationEventHandler handler) throws JAXBException Allow an application to register a `ValidationEventHandler`. The `ValidationEventHandler` will be called by the Jakarta XML Binding Provider if any validation errors are encountered during calls to any of the unmarshal methods. If the client application does not register a `ValidationEventHandler` before invoking the unmarshal methods, then `ValidationEvents` will be handled by the default event handler which will terminate the unmarshal operation after the first error or fatal error is encountered. Calling this method with a null parameter will cause the Unmarshaller to revert back to the default event handler. Parameters handler:ValidationEventHandler the validation event handler Exceptions JAXBException: if an error was encountered while setting the event handler

public void setEventHandler(ValidationEventHandler handler) throws JAXBException

Allow an application to register a ValidationEventHandler.

The ValidationEventHandler will be called by the Jakarta XML Binding Provider if any validation errors are encountered during calls to any of the unmarshal methods. If the client application does not register a ValidationEventHandler before invoking the unmarshal methods, then ValidationEvents will be handled by the default event handler which will terminate the unmarshal operation after the first error or fatal error is encountered.

Calling this method with a null parameter will cause the Unmarshaller to revert back to the default event handler.

Parameters

handler:ValidationEventHandler: the validation event handler

Exceptions

JAXBException:: if an error was encountered while setting the event handler

setListener back to summary

setListener	back to summary
public void setListener(Unmarshaller.Listener listener) 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`. Parameters listener:Unmarshaller.Listener provides unmarshal event callbacks for this `Unmarshaller` Since 1.6, JAXB 2.0

public void setListener(Unmarshaller.Listener listener)

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.

Parameters

listener:Unmarshaller.Listener: provides unmarshal event callbacks for this Unmarshaller

Since

1.6, JAXB 2.0

setProperty back to summary

setProperty	back to summary
public void setProperty(String name, Object value) throws PropertyException Set the particular property in the underlying implementation of `Unmarshaller`. This method can only be used to set one of the standard Jakarta XML Binding defined properties above or a provider specific property. Attempting to set an undefined property will result in a PropertyException being thrown. See Supported Properties. Parameters name:String 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:Object the value of the property to be set Exceptions PropertyException: when there is an error processing the given property or value IllegalArgumentException: If the name parameter is null

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

Set the particular property in the underlying implementation of Unmarshaller. This method can only be used to set one of the standard Jakarta XML Binding defined properties above or a provider specific property. Attempting to set an undefined property will result in a PropertyException being thrown. See Supported Properties.

Parameters

name:String: 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:Object: the value of the property to be set

Exceptions

PropertyException:: when there is an error processing the given property or value
IllegalArgumentException:: If the name parameter is null

setSchema back to summary

setSchema	back to summary
public void setSchema(Schema schema) 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`. Parameters schema:Schema Schema object to validate unmarshal operations against or null to disable validation Exceptions UnsupportedOperationException: could be thrown if this method is invoked on an Unmarshaller created from a JAXBContext referencing JAXB 1.0 mapped classes Since 1.6, JAXB 2.0

public void setSchema(Schema schema)

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.

Parameters

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

Exceptions

UnsupportedOperationException:: could be thrown if this method is invoked on an Unmarshaller created from a JAXBContext referencing JAXB 1.0 mapped classes

Since

1.6, JAXB 2.0

unmarshal back to summary

unmarshal	back to summary
public Object unmarshal(File f) throws JAXBException Unmarshal XML data from the specified file and return the resulting content tree. Implements Unmarshal Global Root Element. Parameters f:File the file to unmarshal XML data from Returns:Object the newly created root object of the java content tree Exceptions 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 IllegalArgumentException: If the file parameter is null

public Object unmarshal(File f) throws JAXBException

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

Implements Unmarshal Global Root Element.

Parameters

f:File: the file to unmarshal XML data from

Returns:Object

the newly created root object of the java content tree

Exceptions

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
IllegalArgumentException:: If the file parameter is null

unmarshal back to summary

unmarshal	back to summary
public Object unmarshal(InputStream is) throws JAXBException Unmarshal XML data from the specified InputStream and return the resulting content tree. Validation event location information may be incomplete when using this form of the unmarshal API. Implements Unmarshal Global Root Element. Parameters is:InputStream the InputStream to unmarshal XML data from Returns:Object the newly created root object of the java content tree Exceptions 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 IllegalArgumentException: If the InputStream parameter is null

public Object unmarshal(InputStream is) throws JAXBException

Unmarshal XML data from the specified InputStream and return the resulting content tree. Validation event location information may be incomplete when using this form of the unmarshal API.

Implements Unmarshal Global Root Element.

Parameters

is:InputStream: the InputStream to unmarshal XML data from

Returns:Object

the newly created root object of the java content tree

Exceptions

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
IllegalArgumentException:: If the InputStream parameter is null

unmarshal back to summary

unmarshal	back to summary
public Object unmarshal(Reader reader) throws JAXBException Unmarshal XML data from the specified Reader and return the resulting content tree. Validation event location information may be incomplete when using this form of the unmarshal API, because a Reader does not provide the system ID. Implements Unmarshal Global Root Element. Parameters reader:Reader the Reader to unmarshal XML data from Returns:Object the newly created root object of the java content tree Exceptions 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 IllegalArgumentException: If the InputStream parameter is null Since 1.6, JAXB 2.0

public Object unmarshal(Reader reader) throws JAXBException

Unmarshal XML data from the specified Reader and return the resulting content tree. Validation event location information may be incomplete when using this form of the unmarshal API, because a Reader does not provide the system ID.

Implements Unmarshal Global Root Element.

Parameters

reader:Reader: the Reader to unmarshal XML data from

Returns:Object

the newly created root object of the java content tree

Exceptions

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
IllegalArgumentException:: If the InputStream parameter is null

Since

1.6, JAXB 2.0

unmarshal back to summary

unmarshal	back to summary
public Object unmarshal(URL url) throws JAXBException Unmarshal XML data from the specified URL and return the resulting content tree. Implements Unmarshal Global Root Element. Parameters url:URL the url to unmarshal XML data from Returns:Object the newly created root object of the java content tree Exceptions 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 IllegalArgumentException: If the URL parameter is null

public Object unmarshal(URL url) throws JAXBException

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

Implements Unmarshal Global Root Element.

Parameters

url:URL: the url to unmarshal XML data from

Returns:Object

the newly created root object of the java content tree

Exceptions

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
IllegalArgumentException:: If the URL parameter is null

unmarshal back to summary

unmarshal	back to summary
public Object unmarshal(InputSource source) throws JAXBException Unmarshal XML data from the specified SAX InputSource and return the resulting content tree. Implements Unmarshal Global Root Element. Parameters source:InputSource the input source to unmarshal XML data from Returns:Object the newly created root object of the java content tree Exceptions 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 IllegalArgumentException: If the InputSource parameter is null

public Object unmarshal(InputSource source) throws JAXBException

Unmarshal XML data from the specified SAX InputSource and return the resulting content tree.

Implements Unmarshal Global Root Element.

Parameters

source:InputSource: the input source to unmarshal XML data from

Returns:Object

the newly created root object of the java content tree

Exceptions

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
IllegalArgumentException:: If the InputSource parameter is null

unmarshal back to summary

unmarshal	back to summary
public Object unmarshal(Node node) throws JAXBException Unmarshal global XML data from the specified DOM tree and return the resulting content tree. Implements Unmarshal Global Root Element. Parameters node:Node the document/element to unmarshal XML data from. The caller must support at least Document and Element. Returns:Object the newly created root object of the java content tree Exceptions 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 IllegalArgumentException: If the Node parameter is null See Also `unmarshal(org.w3c.dom.Node, Class)`

public Object unmarshal(Node node) throws JAXBException

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

Implements Unmarshal Global Root Element.

Parameters

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

Returns:Object

the newly created root object of the java content tree

Exceptions

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
IllegalArgumentException:: If the Node parameter is null

See Also

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

unmarshal back to summary

unmarshal	back to summary
public <T> JAXBElement<T> unmarshal(Node node, Class<T> declaredType) throws JAXBException Unmarshal XML data by Jakarta XML Binding mapped `declaredType` and return the resulting content tree. Implements Unmarshal by Declared Type Parameters <T> the XML Binding mapped class node:Node the document/element to unmarshal XML data from. The caller must support at least Document and Element. declaredType:Class<T> appropriate Jakarta XML Binding mapped class to hold `node`'s XML data. Returns:JAXBElement<T> JAXBElement representation of `node` Exceptions 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 IllegalArgumentException: If any parameter is null Since 1.6, JAXB 2.0

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

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

Implements Unmarshal by Declared Type

Parameters

<T>: the XML Binding mapped class
node:Node: the document/element to unmarshal XML data from. The caller must support at least Document and Element.
declaredType:Class<T>: appropriate Jakarta XML Binding mapped class to hold node's XML data.

Returns:JAXBElement<T>

JAXBElement representation of node

Exceptions

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
IllegalArgumentException:: If any parameter is null

Since

1.6, JAXB 2.0

unmarshal back to summary

unmarshal	back to summary
public Object unmarshal(Source source) throws JAXBException Unmarshal XML data from the specified XML Source and return the resulting content tree. Implements Unmarshal Global Root Element. SAX 2.0 Parser Pluggability A client application can choose not to use the default parser mechanism supplied with their Jakarta XML Binding provider. Any SAX 2.0 compliant parser can be substituted for the Jakarta XML Binding provider's default mechanism. To do so, the client application must properly configure a `SAXSource` containing an `XMLReader` implemented by the SAX 2.0 parser provider. If the `XMLReader` has an `org.xml.sax.ErrorHandler` registered on it, it will be replaced by the Jakarta XML Binding Provider so that validation errors can be reported via the `ValidationEventHandler` mechanism of Jakarta XML Binding. If the `SAXSource` does not contain an `XMLReader`, then the Jakarta XML Binding provider's default parser mechanism will be used. This parser replacement mechanism can also be used to replace the Jakarta XML Binding provider's unmarshal-time validation engine. The client application must properly configure their SAX 2.0 compliant parser to perform validation (as shown in the example above). Any `SAXParserExceptions` encountered by the parser during the unmarshal operation will be processed by the Jakarta XML Binding provider and converted into Jakarta XML Binding `ValidationEvent` objects which will be reported back to the client via the `ValidationEventHandler` registered with the `Unmarshaller` Note specifying a substitute validating SAX 2.0 parser for unmarshalling does not necessarily replace the validation engine used by the Jakarta XML Binding provider for performing on-demand validation. The only way for a client application to specify an alternate parser mechanism to be used during unmarshal is via the `unmarshal(SAXSource)` API. All other forms of the unmarshal method (File, URL, Node, etc) will use the Jakarta XML Binding provider's default parser and validator mechanisms. Parameters source:Source the XML Source to unmarshal XML data from (providers are only required to support SAXSource, DOMSource, and StreamSource) Returns:Object the newly created root object of the java content tree Exceptions 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 IllegalArgumentException: If the Source parameter is null See Also `unmarshal(javax.xml.transform.Source, Class)`

public Object unmarshal(Source source) throws JAXBException

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

Implements Unmarshal Global Root Element.

SAX 2.0 Parser Pluggability

A client application can choose not to use the default parser mechanism supplied with their Jakarta XML Binding provider. Any SAX 2.0 compliant parser can be substituted for the Jakarta XML Binding provider's default mechanism. To do so, the client application must properly configure a SAXSource containing an XMLReader implemented by the SAX 2.0 parser provider. If the XMLReader has an org.xml.sax.ErrorHandler registered on it, it will be replaced by the Jakarta XML Binding Provider so that validation errors can be reported via the ValidationEventHandler mechanism of Jakarta XML Binding. If the SAXSource does not contain an XMLReader, then the Jakarta XML Binding provider's default parser mechanism will be used.

This parser replacement mechanism can also be used to replace the Jakarta XML Binding provider's unmarshal-time validation engine. The client application must properly configure their SAX 2.0 compliant parser to perform validation (as shown in the example above). Any SAXParserExceptions encountered by the parser during the unmarshal operation will be processed by the Jakarta XML Binding provider and converted into Jakarta XML Binding ValidationEvent objects which will be reported back to the client via the ValidationEventHandler registered with the Unmarshaller

Note

specifying a substitute validating SAX 2.0 parser for unmarshalling does not necessarily replace the validation engine used by the Jakarta XML Binding provider for performing on-demand validation.

The only way for a client application to specify an alternate parser mechanism to be used during unmarshal is via the unmarshal(SAXSource) API. All other forms of the unmarshal method (File, URL, Node, etc) will use the Jakarta XML Binding provider's default parser and validator mechanisms.

Parameters

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

Returns:Object

the newly created root object of the java content tree

Exceptions

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
IllegalArgumentException:: If the Source parameter is null

unmarshal back to summary

unmarshal	back to summary
public <T> JAXBElement<T> unmarshal(Source source, Class<T> declaredType) throws JAXBException 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 Parameters <T> the XML Binding mapped class source:Source the XML Source to unmarshal XML data from (providers are only required to support SAXSource, DOMSource, and StreamSource) declaredType:Class<T> appropriate Jakarta XML Binding mapped class to hold `source`'s xml root element Returns:JAXBElement<T> Java content rooted by JAXBElement Exceptions 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 IllegalArgumentException: If any parameter is null Since 1.6, JAXB 2.0

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

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

Parameters

<T>: the XML Binding mapped class
source:Source: the XML Source to unmarshal XML data from (providers are only required to support SAXSource, DOMSource, and StreamSource)
declaredType:Class<T>: appropriate Jakarta XML Binding mapped class to hold source's xml root element

Returns:JAXBElement<T>

Java content rooted by JAXBElement

Exceptions

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
IllegalArgumentException:: If any parameter is null

Since

1.6, JAXB 2.0

unmarshal back to summary

unmarshal	back to summary
public Object unmarshal(XMLStreamReader reader) throws JAXBException 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. Parameters reader:XMLStreamReader The parser to be read. Returns:Object the newly created root object of the java content tree. Exceptions 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 IllegalArgumentException: If the `reader` parameter is null IllegalStateException: If `reader` is not pointing to a START_DOCUMENT or START_ELEMENT event. Since 1.6, JAXB 2.0 See Also `unmarshal(javax.xml.stream.XMLStreamReader, Class)`

public Object unmarshal(XMLStreamReader reader) throws JAXBException

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.

Parameters

reader:XMLStreamReader: The parser to be read.

Returns:Object

the newly created root object of the java content tree.

Exceptions

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
IllegalArgumentException:: If the reader parameter is null
IllegalStateException:: If reader is not pointing to a START_DOCUMENT or START_ELEMENT event.

Since

1.6, JAXB 2.0

unmarshal back to summary

unmarshal	back to summary
public <T> JAXBElement<T> unmarshal(XMLStreamReader reader, Class<T> declaredType) throws JAXBException 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. Parameters <T> the XML Binding mapped class reader:XMLStreamReader The parser to be read. declaredType:Class<T> appropriate Jakarta XML Binding mapped class to hold `reader`'s START_ELEMENT XML data. Returns:JAXBElement<T> content tree rooted by JAXBElement representation Exceptions 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 IllegalArgumentException: If any parameter is null Since 1.6, JAXB 2.0

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

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

This method implements unmarshal by declaredType.

Parameters

<T>: the XML Binding mapped class
reader:XMLStreamReader: The parser to be read.
declaredType:Class<T>: appropriate Jakarta XML Binding mapped class to hold reader's START_ELEMENT XML data.

Returns:JAXBElement<T>

content tree rooted by JAXBElement representation

Exceptions

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
IllegalArgumentException:: If any parameter is null

Since

1.6, JAXB 2.0

unmarshal back to summary

unmarshal	back to summary
public Object unmarshal(XMLEventReader reader) throws JAXBException 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. Parameters reader:XMLEventReader The parser to be read. Returns:Object the newly created root object of the java content tree. Exceptions 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 IllegalArgumentException: If the `reader` parameter is null IllegalStateException: If `reader` is not pointing to a START_DOCUMENT or START_ELEMENT event. Since 1.6, JAXB 2.0 See Also `unmarshal(javax.xml.stream.XMLEventReader, Class)`

public Object unmarshal(XMLEventReader reader) throws JAXBException

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

This method is an Unmarshal Global Root method.

Parameters

reader:XMLEventReader: The parser to be read.

Returns:Object

the newly created root object of the java content tree.

Exceptions

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
IllegalArgumentException:: If the reader parameter is null
IllegalStateException:: If reader is not pointing to a START_DOCUMENT or START_ELEMENT event.

Since

1.6, JAXB 2.0

unmarshal back to summary

unmarshal	back to summary
public <T> JAXBElement<T> unmarshal(XMLEventReader reader, Class<T> declaredType) throws JAXBException 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. Parameters <T> the XML Binding mapped class reader:XMLEventReader The parser to be read. declaredType:Class<T> appropriate Jakarta XML Binding mapped class to hold `reader`'s START_ELEMENT XML data. Returns:JAXBElement<T> content tree rooted by JAXBElement representation Exceptions 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 IllegalArgumentException: If any parameter is null Since 1.6, JAXB 2.0

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

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

This method implements unmarshal by declaredType.

Parameters

<T>: the XML Binding mapped class
reader:XMLEventReader: The parser to be read.
declaredType:Class<T>: appropriate Jakarta XML Binding mapped class to hold reader's START_ELEMENT XML data.

Returns:JAXBElement<T>

content tree rooted by JAXBElement representation

Exceptions

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
IllegalArgumentException:: If any parameter is null

Since

1.6, JAXB 2.0

public Interface Unmarshaller

Nested and Inner Type Summary

Method Summary

Method Detail

public abstract Class Unmarshaller.Listener

Constructor Summary

Method Summary

Constructor Detail

Method Detail

JAXBElement Property	Value
name	`xml element name`
value	`instanceof declaredType`
declaredType	unmarshal method `declaredType` parameter
scope	`null` (actual scope is unknown)

Modifier and Type	Method and Description
public void	afterUnmarshal(Object non-null instance of Jakarta XML Binding mapped class prior to unmarshalling into it. target, Object instance of Jakarta XML Binding mapped class that will reference `target`. `null` when `target` is root element. parent) Callback method invoked after unmarshalling XML data into `target`.
public void	beforeUnmarshal(Object non-null instance of Jakarta XML Binding mapped class prior to unmarshalling into it. target, Object instance of Jakarta XML Binding mapped class that will eventually reference `target`. `null` when `target` is root element. parent) Callback method invoked before unmarshalling into `target`.