public abstract class AbstractUnmarshallerImpl extends Object implements Unmarshaller
Partial default Unmarshaller implementation.
This class provides a partial default implementation for the Unmarshallerinterface.
A JAXB Provider has to implement five methods (getUnmarshallerHandler, unmarshal(Node), unmarshal(XMLReader,InputSource), unmarshal(XMLStreamReader), and unmarshal(XMLEventReader).
UnmarshallerUnmarshaller.Listener protected boolean validating
whether or not the unmarshaller will validate
public AbstractUnmarshallerImpl()
protected XMLReader getXMLReader()
throws JAXBException Obtains a configured XMLReader. This method is used when the client-specified SAXSource object doesn't have XMLReader. Unmarshaller is not re-entrant, so we will only use one instance of XMLReader.
JAXBExceptionpublic Object unmarshal(Source source)
throws JAXBException Description copied from interface: Unmarshaller
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 JAXB provider. Any SAX 2.0 compliant parser can be substituted for the JAXB 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 JAXB Provider so that validation errors can be reported via the ValidationEventHandler mechanism of JAXB. If the SAXSource does not contain an XMLReader, then the JAXB provider's default parser mechanism will be used.
This parser replacement mechanism can also be used to replace the JAXB 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 JAXB provider and converted into JAXB 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 JAXB 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 JAXB provider's default parser and validator mechanisms.
unmarshal in interface Unmarshaller
source - the XML Source to unmarshal XML data from (providers are only required to support SAXSource, DOMSource, and StreamSource)JAXBException - If any unexpected errors occur while unmarshallingUnmarshalException - 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
Unmarshaller.unmarshal(javax.xml.transform.Source, Class)protected abstract Object unmarshal(XMLReader reader,
InputSource source)
throws JAXBException 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.
JAXBExceptionpublic final Object unmarshal(InputSource source)
throws JAXBException Description copied from interface: Unmarshaller
Unmarshal XML data from the specified SAX InputSource and return the resulting content tree.
Implements Unmarshal Global Root Element.
unmarshal in interface Unmarshaller
source - the input source to unmarshal XML data fromJAXBException - If any unexpected errors occur while unmarshallingUnmarshalException - 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
public final Object unmarshal(URL url)
throws JAXBException Description copied from interface: Unmarshaller
Unmarshal XML data from the specified URL and return the resulting content tree.
Implements Unmarshal Global Root Element.
unmarshal in interface Unmarshaller
url - the url to unmarshal XML data fromJAXBException - If any unexpected errors occur while unmarshallingUnmarshalException - 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
public final Object unmarshal(File f)
throws JAXBException Description copied from interface: Unmarshaller
Unmarshal XML data from the specified file and return the resulting content tree.
Implements Unmarshal Global Root Element.
unmarshal in interface Unmarshaller
f - the file to unmarshal XML data fromJAXBException - If any unexpected errors occur while unmarshallingUnmarshalException - 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
public final Object unmarshal(InputStream is)
throws JAXBException Description copied from interface: Unmarshaller
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.
unmarshal in interface Unmarshaller
is - the InputStream to unmarshal XML data fromJAXBException - If any unexpected errors occur while unmarshallingUnmarshalException - 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
public final Object unmarshal(Reader reader)
throws JAXBException Description copied from interface: Unmarshaller
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.
unmarshal in interface Unmarshaller
reader - the Reader to unmarshal XML data fromJAXBException - If any unexpected errors occur while unmarshallingUnmarshalException - 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
public boolean isValidating()
throws JAXBException Indicates whether or not the Unmarshaller is configured to validate during unmarshal operations.
Note: I named this method isValidating() to stay in-line with JAXP, as opposed to naming it getValidating().
isValidating in interface Unmarshaller
JAXBException - if an error occurs while retrieving the validating flagpublic void setEventHandler(ValidationEventHandler handler)
throws JAXBException Allow an application to register a validation event handler.
The validation event handler will be called by the JAXB Provider if any validation errors are encountered during calls to any of the unmarshal methods. If the client application does not register a validation event handler before invoking the unmarshal methods, then all validation events will be silently ignored and may result in unexpected behaviour.
setEventHandler in interface Unmarshaller
handler - the validation event handlerJAXBException - if an error was encountered while setting the event handlerpublic void setValidating(boolean validating)
throws JAXBException Specifies whether or not the Unmarshaller should validate during unmarshal operations. By default, the Unmarshaller does not validate.
This method may only be invoked before or after calling one of the unmarshal methods.
setValidating in interface Unmarshaller
validating - true if the Unmarshaller should validate during unmarshal, false otherwiseJAXBException - if an error occurred while enabling or disabling validation at unmarshal timepublic ValidationEventHandler getEventHandler()
throws JAXBException Return the current event handler or the default event handler if one hasn't been set.
getEventHandler in interface Unmarshaller
JAXBException - if an error was encountered while getting the current event handlerprotected UnmarshalException createUnmarshalException(SAXException e)
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.
public void setProperty(String name,
Object value)
throws PropertyException 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.
setProperty in interface Unmarshaller
name - the name of the property to be set. This value can either be specified using one of the constant fields or a user supplied string.value - the value of the property to be setPropertyException - when there is an error processing the given property or valuepublic Object getProperty(String name)
throws PropertyException 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.
getProperty in interface Unmarshaller
name - the name of the property to retrievePropertyException - when there is an error retrieving the given property or value property namepublic Object unmarshal(XMLEventReader reader)
throws JAXBException Description copied from interface: Unmarshaller
Unmarshal XML data from the specified pull parser and return the resulting content tree.
This method is an Unmarshal Global Root method.
This method assumes that the parser is on a START_DOCUMENT or START_ELEMENT event. Unmarshalling will be done from this start event to the corresponding end event. If this method returns successfully, the reader will be pointing at the token right after the end event.
unmarshal in interface Unmarshaller
reader - The parser to be read.JAXBException - If any unexpected errors occur while unmarshallingUnmarshalException - 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
Unmarshaller.unmarshal(javax.xml.stream.XMLEventReader, Class)public Object unmarshal(XMLStreamReader reader)
throws JAXBException Description copied from interface: Unmarshaller
Unmarshal XML data from the specified pull parser and return the resulting content tree.
Implements Unmarshal Global Root Element.
This method assumes that the parser is on a START_DOCUMENT or START_ELEMENT event. Unmarshalling will be done from this start event to the corresponding end event. If this method returns successfully, the reader will be pointing at the token right after the end event.
unmarshal in interface Unmarshaller
reader - The parser to be read.JAXBException - If any unexpected errors occur while unmarshallingUnmarshalException - 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
Unmarshaller.unmarshal(javax.xml.stream.XMLStreamReader, Class)public <T> JAXBElement<T> unmarshal(Node node,
Class<T> expectedType)
throws JAXBException Description copied from interface: Unmarshaller
Unmarshal XML data by JAXB mapped declaredType and return the resulting content tree.
Implements Unmarshal by Declared Type
unmarshal in interface Unmarshaller
node - the document/element to unmarshal XML data from. The caller must support at least Document and Element.expectedType - appropriate JAXB mapped class to hold node's XML data.node
JAXBException - If any unexpected errors occur while unmarshallingUnmarshalException - 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
public <T> JAXBElement<T> unmarshal(Source source,
Class<T> expectedType)
throws JAXBException Description copied from interface: Unmarshaller
Unmarshal XML data from the specified XML Source by declaredType and return the resulting content tree.
Implements Unmarshal by Declared Type
unmarshal in interface Unmarshaller
source - the XML Source to unmarshal XML data from (providers are only required to support SAXSource, DOMSource, and StreamSource)expectedType - appropriate JAXB mapped class to hold source's xml root elementJAXBException - If any unexpected errors occur while unmarshallingUnmarshalException - 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
public <T> JAXBElement<T> unmarshal(XMLStreamReader reader,
Class<T> expectedType)
throws JAXBException Description copied from interface: Unmarshaller
Unmarshal root element to JAXB 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.
unmarshal in interface Unmarshaller
reader - The parser to be read.expectedType - appropriate JAXB mapped class to hold reader's START_ELEMENT XML data.JAXBException - If any unexpected errors occur while unmarshallingUnmarshalException - 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
public <T> JAXBElement<T> unmarshal(XMLEventReader reader,
Class<T> expectedType)
throws JAXBException Description copied from interface: Unmarshaller
Unmarshal root element to JAXB 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.
unmarshal in interface Unmarshaller
reader - The parser to be read.expectedType - appropriate JAXB mapped class to hold reader's START_ELEMENT XML data.JAXBException - If any unexpected errors occur while unmarshallingUnmarshalException - 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
public void setSchema(Schema schema)
Description copied from interface: Unmarshaller
Specify the JAXP 1.3 Schema object that should be used to validate subsequent unmarshal operations against. Passing null into this method will disable validation.
This method replaces the deprecated setValidating(boolean) API.
Initially this property is set to null.
setSchema in interface Unmarshaller
schema - Schema object to validate unmarshal operations against or null to disable validationpublic Schema getSchema()
Description copied from interface: Unmarshaller
Get the JAXP 1.3 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.
This method provides replacement functionality for the deprecated Unmarshaller.isValidating() API as well as access to the Schema object. To determine if the Unmarshaller has validation enabled, simply test the return type for null:
boolean isValidating = u.getSchema()!=null;
getSchema in interface Unmarshaller
public void setAdapter(XmlAdapter adapter)
Description copied from interface: Unmarshaller
Associates a configured instance of XmlAdapter with this unmarshaller.
This is a convenience method that invokes setAdapter(adapter.getClass(),adapter);.
setAdapter in interface Unmarshaller
Unmarshaller.setAdapter(Class,XmlAdapter)public <A extends XmlAdapter> void setAdapter(Class<A> type,
A adapter) Description copied from interface: Unmarshaller
Associates a configured instance of XmlAdapter with this unmarshaller.
Every unmarshaller internally maintains a Map<Class,XmlAdapter>, which it uses for unmarshalling classes whose fields/methods are annotated with XmlJavaTypeAdapter.
This method allows applications to use a configured instance of XmlAdapter. When an instance of an adapter is not given, an unmarshaller will create one by invoking its default constructor.
setAdapter in interface Unmarshaller
type - The type of the adapter. The specified instance will be used when XmlJavaTypeAdapter.value() refers to this type.adapter - The instance of the adapter to be used. If null, it will un-register the current adapter set for this type.public <A extends XmlAdapter> A getAdapter(Class<A> type)
Description copied from interface: Unmarshaller
Gets the adapter associated with the specified type. This is the reverse operation of the Unmarshaller.setAdapter(javax.xml.bind.annotation.adapters.XmlAdapter) method.
getAdapter in interface Unmarshaller
public void setAttachmentUnmarshaller(AttachmentUnmarshaller au)
Description copied from interface: Unmarshaller
Associate a context that resolves cid's, content-id URIs, to binary data passed as attachments.
Unmarshal time validation, enabled via Unmarshaller.setSchema(Schema), must be supported even when unmarshaller is performing XOP processing.
setAttachmentUnmarshaller in interface Unmarshaller
public AttachmentUnmarshaller getAttachmentUnmarshaller()
getAttachmentUnmarshaller in interface Unmarshaller
public void setListener(Unmarshaller.Listener listener)
Description copied from interface: Unmarshaller
Register unmarshal event callback Unmarshaller.Listener with this Unmarshaller.
There is only one Listener per Unmarshaller. Setting a Listener replaces the previous set Listener. One can unregister current Listener by setting listener to null.
setListener in interface Unmarshaller
listener - provides unmarshal event callbacks for this Unmarshaller
public Unmarshaller.Listener getListener()
Description copied from interface: Unmarshaller
Return Unmarshaller.Listener registered with this Unmarshaller.
getListener in interface Unmarshaller
Unmarshaller.Listener or null if no Listener is registered with this Unmarshaller.
© 1993–2017, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.