| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_11) on Wed Sep 18 01:53:45 EDT 2013 --> |
| <title>AbstractUnmarshallerImpl (EclipseLink 2.5.1, build 'v20130918-f2b9fc5' API Reference)</title> |
| <meta name="date" content="2013-09-18"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="AbstractUnmarshallerImpl (EclipseLink 2.5.1, build 'v20130918-f2b9fc5' API Reference)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><em>EclipseLink 2.5.1, build 'v20130918-f2b9fc5' API Reference</em></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../javax/xml/bind/helpers/AbstractMarshallerImpl.html" title="class in javax.xml.bind.helpers"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../javax/xml/bind/helpers/DefaultValidationEventHandler.html" title="class in javax.xml.bind.helpers"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?javax/xml/bind/helpers/AbstractUnmarshallerImpl.html" target="_top">Frames</a></li> |
| <li><a href="AbstractUnmarshallerImpl.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field_summary">Field</a> | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </li> |
| <li><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">javax.xml.bind.helpers</div> |
| <h2 title="Class AbstractUnmarshallerImpl" class="title">Class AbstractUnmarshallerImpl</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>javax.xml.bind.helpers.AbstractUnmarshallerImpl</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../javax/xml/bind/Unmarshaller.html" title="interface in javax.xml.bind">Unmarshaller</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="strong">AbstractUnmarshallerImpl</span> |
| extends java.lang.Object |
| implements <a href="../../../../javax/xml/bind/Unmarshaller.html" title="interface in javax.xml.bind">Unmarshaller</a></pre> |
| <div class="block">Partial default <tt>Unmarshaller</tt> implementation. |
| |
| <p> |
| This class provides a partial default implementation for the |
| <a href="../../../../javax/xml/bind/Unmarshaller.html" title="interface in javax.xml.bind"><code>Unmarshaller</code></a>interface. |
| |
| <p> |
| A JAXB Provider has to implement five methods (getUnmarshallerHandler, |
| unmarshal(Node), unmarshal(XMLReader,InputSource), |
| unmarshal(XMLStreamReader), and unmarshal(XMLEventReader).</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../javax/xml/bind/Unmarshaller.html" title="interface in javax.xml.bind"><code>Unmarshaller</code></a></dd><dt><span class="strong">Author:</span></dt> |
| <dd><ul> |
| <li>Kohsuke Kawaguchi, Sun Microsystems, Inc.</li> |
| </ul></dd> |
| <dt><span class="strong">Since:</span></dt> |
| <dd>JAXB1.0</dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested_class_summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested_classes_inherited_from_class_javax.xml.bind.Unmarshaller"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface javax.xml.bind.<a href="../../../../javax/xml/bind/Unmarshaller.html" title="interface in javax.xml.bind">Unmarshaller</a></h3> |
| <code><a href="../../../../javax/xml/bind/Unmarshaller.Listener.html" title="class in javax.xml.bind">Unmarshaller.Listener</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../javax/xml/bind/helpers/AbstractUnmarshallerImpl.html#validating">validating</a></strong></code> |
| <div class="block">whether or not the unmarshaller will validate</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../javax/xml/bind/helpers/AbstractUnmarshallerImpl.html#AbstractUnmarshallerImpl()">AbstractUnmarshallerImpl</a></strong>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../javax/xml/bind/UnmarshalException.html" title="class in javax.xml.bind">UnmarshalException</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../javax/xml/bind/helpers/AbstractUnmarshallerImpl.html#createUnmarshalException(org.xml.sax.SAXException)">createUnmarshalException</a></strong>(org.xml.sax.SAXException e)</code> |
| <div class="block">Creates an UnmarshalException from a SAXException.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><A extends <a href="../../../../javax/xml/bind/annotation/adapters/XmlAdapter.html" title="class in javax.xml.bind.annotation.adapters">XmlAdapter</a>> <br>A</code></td> |
| <td class="colLast"><code><strong><a href="../../../../javax/xml/bind/helpers/AbstractUnmarshallerImpl.html#getAdapter(java.lang.Class)">getAdapter</a></strong>(java.lang.Class<A> type)</code> |
| <div class="block">Gets the adapter associated with the specified type.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../javax/xml/bind/attachment/AttachmentUnmarshaller.html" title="class in javax.xml.bind.attachment">AttachmentUnmarshaller</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../javax/xml/bind/helpers/AbstractUnmarshallerImpl.html#getAttachmentUnmarshaller()">getAttachmentUnmarshaller</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../javax/xml/bind/ValidationEventHandler.html" title="interface in javax.xml.bind">ValidationEventHandler</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../javax/xml/bind/helpers/AbstractUnmarshallerImpl.html#getEventHandler()">getEventHandler</a></strong>()</code> |
| <div class="block">Return the current event handler or the default event handler if one |
| hasn't been set.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../javax/xml/bind/Unmarshaller.Listener.html" title="class in javax.xml.bind">Unmarshaller.Listener</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../javax/xml/bind/helpers/AbstractUnmarshallerImpl.html#getListener()">getListener</a></strong>()</code> |
| <div class="block">Return <a href="../../../../javax/xml/bind/Unmarshaller.Listener.html" title="class in javax.xml.bind"><code>Unmarshaller.Listener</code></a> registered with this <a href="../../../../javax/xml/bind/Unmarshaller.html" title="interface in javax.xml.bind"><code>Unmarshaller</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>java.lang.Object</code></td> |
| <td class="colLast"><code><strong><a href="../../../../javax/xml/bind/helpers/AbstractUnmarshallerImpl.html#getProperty(java.lang.String)">getProperty</a></strong>(java.lang.String name)</code> |
| <div class="block">Default implementation of the getProperty method always |
| throws PropertyException since there are no required |
| properties.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>javax.xml.validation.Schema</code></td> |
| <td class="colLast"><code><strong><a href="../../../../javax/xml/bind/helpers/AbstractUnmarshallerImpl.html#getSchema()">getSchema</a></strong>()</code> |
| <div class="block">Get the JAXP 1.3 <code>Schema</code> object |
| being used to perform unmarshal-time validation.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected org.xml.sax.XMLReader</code></td> |
| <td class="colLast"><code><strong><a href="../../../../javax/xml/bind/helpers/AbstractUnmarshallerImpl.html#getXMLReader()">getXMLReader</a></strong>()</code> |
| <div class="block">Obtains a configured XMLReader.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../javax/xml/bind/helpers/AbstractUnmarshallerImpl.html#isValidating()">isValidating</a></strong>()</code> |
| <div class="block">Indicates whether or not the Unmarshaller is configured to validate |
| during unmarshal operations.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><A extends <a href="../../../../javax/xml/bind/annotation/adapters/XmlAdapter.html" title="class in javax.xml.bind.annotation.adapters">XmlAdapter</a>> <br>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../javax/xml/bind/helpers/AbstractUnmarshallerImpl.html#setAdapter(java.lang.Class, A)">setAdapter</a></strong>(java.lang.Class<A> type, |
| A adapter)</code> |
| <div class="block">Associates a configured instance of <a href="../../../../javax/xml/bind/annotation/adapters/XmlAdapter.html" title="class in javax.xml.bind.annotation.adapters"><code>XmlAdapter</code></a> with this unmarshaller.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../javax/xml/bind/helpers/AbstractUnmarshallerImpl.html#setAdapter(javax.xml.bind.annotation.adapters.XmlAdapter)">setAdapter</a></strong>(<a href="../../../../javax/xml/bind/annotation/adapters/XmlAdapter.html" title="class in javax.xml.bind.annotation.adapters">XmlAdapter</a> adapter)</code> |
| <div class="block">Associates a configured instance of <a href="../../../../javax/xml/bind/annotation/adapters/XmlAdapter.html" title="class in javax.xml.bind.annotation.adapters"><code>XmlAdapter</code></a> with this unmarshaller.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../javax/xml/bind/helpers/AbstractUnmarshallerImpl.html#setAttachmentUnmarshaller(javax.xml.bind.attachment.AttachmentUnmarshaller)">setAttachmentUnmarshaller</a></strong>(<a href="../../../../javax/xml/bind/attachment/AttachmentUnmarshaller.html" title="class in javax.xml.bind.attachment">AttachmentUnmarshaller</a> au)</code> |
| <div class="block">Associate a context that resolves cid's, content-id URIs, to |
| binary data passed as attachments.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../javax/xml/bind/helpers/AbstractUnmarshallerImpl.html#setEventHandler(javax.xml.bind.ValidationEventHandler)">setEventHandler</a></strong>(<a href="../../../../javax/xml/bind/ValidationEventHandler.html" title="interface in javax.xml.bind">ValidationEventHandler</a> handler)</code> |
| <div class="block">Allow an application to register a validation event handler.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../javax/xml/bind/helpers/AbstractUnmarshallerImpl.html#setListener(javax.xml.bind.Unmarshaller.Listener)">setListener</a></strong>(<a href="../../../../javax/xml/bind/Unmarshaller.Listener.html" title="class in javax.xml.bind">Unmarshaller.Listener</a> listener)</code> |
| <div class="block"> |
| Register unmarshal event callback <a href="../../../../javax/xml/bind/Unmarshaller.Listener.html" title="class in javax.xml.bind"><code>Unmarshaller.Listener</code></a> with this <a href="../../../../javax/xml/bind/Unmarshaller.html" title="interface in javax.xml.bind"><code>Unmarshaller</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../javax/xml/bind/helpers/AbstractUnmarshallerImpl.html#setProperty(java.lang.String, java.lang.Object)">setProperty</a></strong>(java.lang.String name, |
| java.lang.Object value)</code> |
| <div class="block">Default implementation of the setProperty method always |
| throws PropertyException since there are no required |
| properties.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../javax/xml/bind/helpers/AbstractUnmarshallerImpl.html#setSchema(javax.xml.validation.Schema)">setSchema</a></strong>(javax.xml.validation.Schema schema)</code> |
| <div class="block">Specify the JAXP 1.3 <code>Schema</code> |
| object that should be used to validate subsequent unmarshal operations |
| against.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../javax/xml/bind/helpers/AbstractUnmarshallerImpl.html#setValidating(boolean)">setValidating</a></strong>(boolean validating)</code> |
| <div class="block">Specifies whether or not the Unmarshaller should validate during |
| unmarshal operations.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>java.lang.Object</code></td> |
| <td class="colLast"><code><strong><a href="../../../../javax/xml/bind/helpers/AbstractUnmarshallerImpl.html#unmarshal(java.io.File)">unmarshal</a></strong>(java.io.File f)</code> |
| <div class="block">Unmarshal XML data from the specified file and return the resulting |
| content tree.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>java.lang.Object</code></td> |
| <td class="colLast"><code><strong><a href="../../../../javax/xml/bind/helpers/AbstractUnmarshallerImpl.html#unmarshal(org.xml.sax.InputSource)">unmarshal</a></strong>(org.xml.sax.InputSource source)</code> |
| <div class="block">Unmarshal XML data from the specified SAX InputSource and return the |
| resulting content tree.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>java.lang.Object</code></td> |
| <td class="colLast"><code><strong><a href="../../../../javax/xml/bind/helpers/AbstractUnmarshallerImpl.html#unmarshal(java.io.InputStream)">unmarshal</a></strong>(java.io.InputStream is)</code> |
| <div class="block">Unmarshal XML data from the specified InputStream and return the |
| resulting content tree.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><T> <a href="../../../../javax/xml/bind/JAXBElement.html" title="class in javax.xml.bind">JAXBElement</a><T></code></td> |
| <td class="colLast"><code><strong><a href="../../../../javax/xml/bind/helpers/AbstractUnmarshallerImpl.html#unmarshal(org.w3c.dom.Node, java.lang.Class)">unmarshal</a></strong>(org.w3c.dom.Node node, |
| java.lang.Class<T> expectedType)</code> |
| <div class="block">Unmarshal XML data by JAXB mapped <tt>declaredType</tt> |
| and return the resulting content tree.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>java.lang.Object</code></td> |
| <td class="colLast"><code><strong><a href="../../../../javax/xml/bind/helpers/AbstractUnmarshallerImpl.html#unmarshal(java.io.Reader)">unmarshal</a></strong>(java.io.Reader reader)</code> |
| <div class="block">Unmarshal XML data from the specified Reader and return the |
| resulting content tree.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>java.lang.Object</code></td> |
| <td class="colLast"><code><strong><a href="../../../../javax/xml/bind/helpers/AbstractUnmarshallerImpl.html#unmarshal(javax.xml.transform.Source)">unmarshal</a></strong>(javax.xml.transform.Source source)</code> |
| <div class="block">Unmarshal XML data from the specified XML Source and return the |
| resulting content tree.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><T> <a href="../../../../javax/xml/bind/JAXBElement.html" title="class in javax.xml.bind">JAXBElement</a><T></code></td> |
| <td class="colLast"><code><strong><a href="../../../../javax/xml/bind/helpers/AbstractUnmarshallerImpl.html#unmarshal(javax.xml.transform.Source, java.lang.Class)">unmarshal</a></strong>(javax.xml.transform.Source source, |
| java.lang.Class<T> expectedType)</code> |
| <div class="block">Unmarshal XML data from the specified XML Source by <tt>declaredType</tt> and return the |
| resulting content tree.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>java.lang.Object</code></td> |
| <td class="colLast"><code><strong><a href="../../../../javax/xml/bind/helpers/AbstractUnmarshallerImpl.html#unmarshal(java.net.URL)">unmarshal</a></strong>(java.net.URL url)</code> |
| <div class="block">Unmarshal XML data from the specified URL and return the resulting |
| content tree.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>java.lang.Object</code></td> |
| <td class="colLast"><code><strong><a href="../../../../javax/xml/bind/helpers/AbstractUnmarshallerImpl.html#unmarshal(javax.xml.stream.XMLEventReader)">unmarshal</a></strong>(javax.xml.stream.XMLEventReader reader)</code> |
| <div class="block">Unmarshal XML data from the specified pull parser and return the |
| resulting content tree.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><T> <a href="../../../../javax/xml/bind/JAXBElement.html" title="class in javax.xml.bind">JAXBElement</a><T></code></td> |
| <td class="colLast"><code><strong><a href="../../../../javax/xml/bind/helpers/AbstractUnmarshallerImpl.html#unmarshal(javax.xml.stream.XMLEventReader, java.lang.Class)">unmarshal</a></strong>(javax.xml.stream.XMLEventReader reader, |
| java.lang.Class<T> expectedType)</code> |
| <div class="block">Unmarshal root element to JAXB mapped <tt>declaredType</tt> |
| and return the resulting content tree.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected abstract java.lang.Object</code></td> |
| <td class="colLast"><code><strong><a href="../../../../javax/xml/bind/helpers/AbstractUnmarshallerImpl.html#unmarshal(org.xml.sax.XMLReader, org.xml.sax.InputSource)">unmarshal</a></strong>(org.xml.sax.XMLReader reader, |
| org.xml.sax.InputSource source)</code> |
| <div class="block">Unmarshals an object by using the specified XMLReader and the InputSource.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>java.lang.Object</code></td> |
| <td class="colLast"><code><strong><a href="../../../../javax/xml/bind/helpers/AbstractUnmarshallerImpl.html#unmarshal(javax.xml.stream.XMLStreamReader)">unmarshal</a></strong>(javax.xml.stream.XMLStreamReader reader)</code> |
| <div class="block">Unmarshal XML data from the specified pull parser and return the |
| resulting content tree.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><T> <a href="../../../../javax/xml/bind/JAXBElement.html" title="class in javax.xml.bind">JAXBElement</a><T></code></td> |
| <td class="colLast"><code><strong><a href="../../../../javax/xml/bind/helpers/AbstractUnmarshallerImpl.html#unmarshal(javax.xml.stream.XMLStreamReader, java.lang.Class)">unmarshal</a></strong>(javax.xml.stream.XMLStreamReader reader, |
| java.lang.Class<T> expectedType)</code> |
| <div class="block">Unmarshal root element to JAXB mapped <tt>declaredType</tt> |
| and return the resulting content tree.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_javax.xml.bind.Unmarshaller"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface javax.xml.bind.<a href="../../../../javax/xml/bind/Unmarshaller.html" title="interface in javax.xml.bind">Unmarshaller</a></h3> |
| <code><a href="../../../../javax/xml/bind/Unmarshaller.html#getUnmarshallerHandler()">getUnmarshallerHandler</a>, <a href="../../../../javax/xml/bind/Unmarshaller.html#unmarshal(org.w3c.dom.Node)">unmarshal</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="validating"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>validating</h4> |
| <pre>protected boolean validating</pre> |
| <div class="block">whether or not the unmarshaller will validate</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="AbstractUnmarshallerImpl()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>AbstractUnmarshallerImpl</h4> |
| <pre>public AbstractUnmarshallerImpl()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getXMLReader()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getXMLReader</h4> |
| <pre>protected org.xml.sax.XMLReader getXMLReader() |
| throws <a href="../../../../javax/xml/bind/JAXBException.html" title="class in javax.xml.bind">JAXBException</a></pre> |
| <div class="block">Obtains a configured XMLReader. |
| |
| This method is used when the client-specified |
| <code>SAXSource</code> object doesn't have XMLReader. |
| |
| <a href="../../../../javax/xml/bind/Unmarshaller.html" title="interface in javax.xml.bind"><code>Unmarshaller</code></a> is not re-entrant, so we will |
| only use one instance of XMLReader.</div> |
| <dl><dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../javax/xml/bind/JAXBException.html" title="class in javax.xml.bind">JAXBException</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="unmarshal(javax.xml.transform.Source)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unmarshal</h4> |
| <pre>public java.lang.Object unmarshal(javax.xml.transform.Source source) |
| throws <a href="../../../../javax/xml/bind/JAXBException.html" title="class in javax.xml.bind">JAXBException</a></pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../javax/xml/bind/Unmarshaller.html#unmarshal(javax.xml.transform.Source)">Unmarshaller</a></code></strong></div> |
| <div class="block">Unmarshal XML data from the specified XML Source and return the |
| resulting content tree. |
| |
| <p> |
| Implements <a href="#unmarshalGlobal">Unmarshal Global Root Element</a>. |
| |
| <p> |
| <a name="saxParserPlugable"></a> |
| <b>SAX 2.0 Parser Pluggability</b> |
| <p> |
| 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 <tt>SAXSource</tt> containing |
| an <tt>XMLReader</tt> implemented by the SAX 2.0 parser provider. If the |
| <tt>XMLReader</tt> has an <tt>org.xml.sax.ErrorHandler</tt> registered |
| on it, it will be replaced by the JAXB Provider so that validation errors |
| can be reported via the <tt>ValidationEventHandler</tt> mechanism of |
| JAXB. If the <tt>SAXSource</tt> does not contain an <tt>XMLReader</tt>, |
| then the JAXB provider's default parser mechanism will be used. |
| <p> |
| 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 <tt>SAXParserExceptions |
| </tt> encountered by the parser during the unmarshal operation will be |
| processed by the JAXB provider and converted into JAXB |
| <tt>ValidationEvent</tt> objects which will be reported back to the |
| client via the <tt>ValidationEventHandler</tt> registered with the |
| <tt>Unmarshaller</tt>. <i>Note:</i> 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. |
| <p> |
| The only way for a client application to specify an alternate parser |
| mechanism to be used during unmarshal is via the |
| <tt>unmarshal(SAXSource)</tt> API. All other forms of the unmarshal |
| method (File, URL, Node, etc) will use the JAXB provider's default |
| parser and validator mechanisms.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../javax/xml/bind/Unmarshaller.html#unmarshal(javax.xml.transform.Source)">unmarshal</a></code> in interface <code><a href="../../../../javax/xml/bind/Unmarshaller.html" title="interface in javax.xml.bind">Unmarshaller</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>source</code> - the XML Source to unmarshal XML data from (providers are |
| only required to support SAXSource, DOMSource, and StreamSource)</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the newly created root object of the java content tree</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../javax/xml/bind/JAXBException.html" title="class in javax.xml.bind">JAXBException</a></code> - If any unexpected errors occur while unmarshalling</dd> |
| <dd><code><a href="../../../../javax/xml/bind/UnmarshalException.html" title="class in javax.xml.bind">UnmarshalException</a></code> - If the <a href="../../../../javax/xml/bind/ValidationEventHandler.html" title="interface in javax.xml.bind"><code>ValidationEventHandler</code></a> |
| returns false from its <tt>handleEvent</tt> method or the |
| <tt>Unmarshaller</tt> is unable to perform the XML to Java |
| binding. See <a href="#unmarshalEx">Unmarshalling XML Data</a></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../javax/xml/bind/Unmarshaller.html#unmarshal(javax.xml.transform.Source, java.lang.Class)"><code>Unmarshaller.unmarshal(javax.xml.transform.Source, Class)</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="unmarshal(org.xml.sax.XMLReader, org.xml.sax.InputSource)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unmarshal</h4> |
| <pre>protected abstract java.lang.Object unmarshal(org.xml.sax.XMLReader reader, |
| org.xml.sax.InputSource source) |
| throws <a href="../../../../javax/xml/bind/JAXBException.html" title="class in javax.xml.bind">JAXBException</a></pre> |
| <div class="block">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.</div> |
| <dl><dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../javax/xml/bind/JAXBException.html" title="class in javax.xml.bind">JAXBException</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="unmarshal(org.xml.sax.InputSource)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unmarshal</h4> |
| <pre>public final java.lang.Object unmarshal(org.xml.sax.InputSource source) |
| throws <a href="../../../../javax/xml/bind/JAXBException.html" title="class in javax.xml.bind">JAXBException</a></pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../javax/xml/bind/Unmarshaller.html#unmarshal(org.xml.sax.InputSource)">Unmarshaller</a></code></strong></div> |
| <div class="block">Unmarshal XML data from the specified SAX InputSource and return the |
| resulting content tree. |
| |
| <p> |
| Implements <a href="#unmarshalGlobal">Unmarshal Global Root Element</a>.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../javax/xml/bind/Unmarshaller.html#unmarshal(org.xml.sax.InputSource)">unmarshal</a></code> in interface <code><a href="../../../../javax/xml/bind/Unmarshaller.html" title="interface in javax.xml.bind">Unmarshaller</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>source</code> - the input source to unmarshal XML data from</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the newly created root object of the java content tree</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../javax/xml/bind/JAXBException.html" title="class in javax.xml.bind">JAXBException</a></code> - If any unexpected errors occur while unmarshalling</dd> |
| <dd><code><a href="../../../../javax/xml/bind/UnmarshalException.html" title="class in javax.xml.bind">UnmarshalException</a></code> - If the <a href="../../../../javax/xml/bind/ValidationEventHandler.html" title="interface in javax.xml.bind"><code>ValidationEventHandler</code></a> |
| returns false from its <tt>handleEvent</tt> method or the |
| <tt>Unmarshaller</tt> is unable to perform the XML to Java |
| binding. See <a href="#unmarshalEx">Unmarshalling XML Data</a></dd></dl> |
| </li> |
| </ul> |
| <a name="unmarshal(java.net.URL)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unmarshal</h4> |
| <pre>public final java.lang.Object unmarshal(java.net.URL url) |
| throws <a href="../../../../javax/xml/bind/JAXBException.html" title="class in javax.xml.bind">JAXBException</a></pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../javax/xml/bind/Unmarshaller.html#unmarshal(java.net.URL)">Unmarshaller</a></code></strong></div> |
| <div class="block">Unmarshal XML data from the specified URL and return the resulting |
| content tree. |
| |
| <p> |
| Implements <a href="#unmarshalGlobal">Unmarshal Global Root Element</a>.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../javax/xml/bind/Unmarshaller.html#unmarshal(java.net.URL)">unmarshal</a></code> in interface <code><a href="../../../../javax/xml/bind/Unmarshaller.html" title="interface in javax.xml.bind">Unmarshaller</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>url</code> - the url to unmarshal XML data from</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the newly created root object of the java content tree</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../javax/xml/bind/JAXBException.html" title="class in javax.xml.bind">JAXBException</a></code> - If any unexpected errors occur while unmarshalling</dd> |
| <dd><code><a href="../../../../javax/xml/bind/UnmarshalException.html" title="class in javax.xml.bind">UnmarshalException</a></code> - If the <a href="../../../../javax/xml/bind/ValidationEventHandler.html" title="interface in javax.xml.bind"><code>ValidationEventHandler</code></a> |
| returns false from its <tt>handleEvent</tt> method or the |
| <tt>Unmarshaller</tt> is unable to perform the XML to Java |
| binding. See <a href="#unmarshalEx">Unmarshalling XML Data</a></dd></dl> |
| </li> |
| </ul> |
| <a name="unmarshal(java.io.File)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unmarshal</h4> |
| <pre>public final java.lang.Object unmarshal(java.io.File f) |
| throws <a href="../../../../javax/xml/bind/JAXBException.html" title="class in javax.xml.bind">JAXBException</a></pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../javax/xml/bind/Unmarshaller.html#unmarshal(java.io.File)">Unmarshaller</a></code></strong></div> |
| <div class="block">Unmarshal XML data from the specified file and return the resulting |
| content tree. |
| |
| <p> |
| Implements <a href="#unmarshalGlobal">Unmarshal Global Root Element</a>.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../javax/xml/bind/Unmarshaller.html#unmarshal(java.io.File)">unmarshal</a></code> in interface <code><a href="../../../../javax/xml/bind/Unmarshaller.html" title="interface in javax.xml.bind">Unmarshaller</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>f</code> - the file to unmarshal XML data from</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the newly created root object of the java content tree</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../javax/xml/bind/JAXBException.html" title="class in javax.xml.bind">JAXBException</a></code> - If any unexpected errors occur while unmarshalling</dd> |
| <dd><code><a href="../../../../javax/xml/bind/UnmarshalException.html" title="class in javax.xml.bind">UnmarshalException</a></code> - If the <a href="../../../../javax/xml/bind/ValidationEventHandler.html" title="interface in javax.xml.bind"><code>ValidationEventHandler</code></a> |
| returns false from its <tt>handleEvent</tt> method or the |
| <tt>Unmarshaller</tt> is unable to perform the XML to Java |
| binding. See <a href="#unmarshalEx">Unmarshalling XML Data</a></dd></dl> |
| </li> |
| </ul> |
| <a name="unmarshal(java.io.InputStream)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unmarshal</h4> |
| <pre>public final java.lang.Object unmarshal(java.io.InputStream is) |
| throws <a href="../../../../javax/xml/bind/JAXBException.html" title="class in javax.xml.bind">JAXBException</a></pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../javax/xml/bind/Unmarshaller.html#unmarshal(java.io.InputStream)">Unmarshaller</a></code></strong></div> |
| <div class="block">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. |
| |
| <p> |
| Implements <a href="#unmarshalGlobal">Unmarshal Global Root Element</a>.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../javax/xml/bind/Unmarshaller.html#unmarshal(java.io.InputStream)">unmarshal</a></code> in interface <code><a href="../../../../javax/xml/bind/Unmarshaller.html" title="interface in javax.xml.bind">Unmarshaller</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>is</code> - the InputStream to unmarshal XML data from</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the newly created root object of the java content tree</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../javax/xml/bind/JAXBException.html" title="class in javax.xml.bind">JAXBException</a></code> - If any unexpected errors occur while unmarshalling</dd> |
| <dd><code><a href="../../../../javax/xml/bind/UnmarshalException.html" title="class in javax.xml.bind">UnmarshalException</a></code> - If the <a href="../../../../javax/xml/bind/ValidationEventHandler.html" title="interface in javax.xml.bind"><code>ValidationEventHandler</code></a> |
| returns false from its <tt>handleEvent</tt> method or the |
| <tt>Unmarshaller</tt> is unable to perform the XML to Java |
| binding. See <a href="#unmarshalEx">Unmarshalling XML Data</a></dd></dl> |
| </li> |
| </ul> |
| <a name="unmarshal(java.io.Reader)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unmarshal</h4> |
| <pre>public final java.lang.Object unmarshal(java.io.Reader reader) |
| throws <a href="../../../../javax/xml/bind/JAXBException.html" title="class in javax.xml.bind">JAXBException</a></pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../javax/xml/bind/Unmarshaller.html#unmarshal(java.io.Reader)">Unmarshaller</a></code></strong></div> |
| <div class="block">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. |
| |
| <p> |
| Implements <a href="#unmarshalGlobal">Unmarshal Global Root Element</a>.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../javax/xml/bind/Unmarshaller.html#unmarshal(java.io.Reader)">unmarshal</a></code> in interface <code><a href="../../../../javax/xml/bind/Unmarshaller.html" title="interface in javax.xml.bind">Unmarshaller</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>reader</code> - the Reader to unmarshal XML data from</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the newly created root object of the java content tree</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../javax/xml/bind/JAXBException.html" title="class in javax.xml.bind">JAXBException</a></code> - If any unexpected errors occur while unmarshalling</dd> |
| <dd><code><a href="../../../../javax/xml/bind/UnmarshalException.html" title="class in javax.xml.bind">UnmarshalException</a></code> - If the <a href="../../../../javax/xml/bind/ValidationEventHandler.html" title="interface in javax.xml.bind"><code>ValidationEventHandler</code></a> |
| returns false from its <tt>handleEvent</tt> method or the |
| <tt>Unmarshaller</tt> is unable to perform the XML to Java |
| binding. See <a href="#unmarshalEx">Unmarshalling XML Data</a></dd></dl> |
| </li> |
| </ul> |
| <a name="isValidating()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isValidating</h4> |
| <pre>public boolean isValidating() |
| throws <a href="../../../../javax/xml/bind/JAXBException.html" title="class in javax.xml.bind">JAXBException</a></pre> |
| <div class="block">Indicates whether or not the Unmarshaller is configured to validate |
| during unmarshal operations. |
| <p> |
| <i><b>Note:</b> I named this method isValidating() to stay in-line |
| with JAXP, as opposed to naming it getValidating(). </i></div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../javax/xml/bind/Unmarshaller.html#isValidating()">isValidating</a></code> in interface <code><a href="../../../../javax/xml/bind/Unmarshaller.html" title="interface in javax.xml.bind">Unmarshaller</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>true if the Unmarshaller is configured to validate during |
| unmarshal operations, false otherwise</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../javax/xml/bind/JAXBException.html" title="class in javax.xml.bind">JAXBException</a></code> - if an error occurs while retrieving the validating |
| flag</dd></dl> |
| </li> |
| </ul> |
| <a name="setEventHandler(javax.xml.bind.ValidationEventHandler)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setEventHandler</h4> |
| <pre>public void setEventHandler(<a href="../../../../javax/xml/bind/ValidationEventHandler.html" title="interface in javax.xml.bind">ValidationEventHandler</a> handler) |
| throws <a href="../../../../javax/xml/bind/JAXBException.html" title="class in javax.xml.bind">JAXBException</a></pre> |
| <div class="block">Allow an application to register a validation event handler. |
| <p> |
| The validation event handler will be called by the JAXB Provider if any |
| validation errors are encountered during calls to any of the |
| <tt>unmarshal</tt> 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.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../javax/xml/bind/Unmarshaller.html#setEventHandler(javax.xml.bind.ValidationEventHandler)">setEventHandler</a></code> in interface <code><a href="../../../../javax/xml/bind/Unmarshaller.html" title="interface in javax.xml.bind">Unmarshaller</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>handler</code> - the validation event handler</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../javax/xml/bind/JAXBException.html" title="class in javax.xml.bind">JAXBException</a></code> - if an error was encountered while setting the |
| event handler</dd></dl> |
| </li> |
| </ul> |
| <a name="setValidating(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setValidating</h4> |
| <pre>public void setValidating(boolean validating) |
| throws <a href="../../../../javax/xml/bind/JAXBException.html" title="class in javax.xml.bind">JAXBException</a></pre> |
| <div class="block">Specifies whether or not the Unmarshaller should validate during |
| unmarshal operations. By default, the <tt>Unmarshaller</tt> does |
| not validate. |
| <p> |
| This method may only be invoked before or after calling one of the |
| unmarshal methods.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../javax/xml/bind/Unmarshaller.html#setValidating(boolean)">setValidating</a></code> in interface <code><a href="../../../../javax/xml/bind/Unmarshaller.html" title="interface in javax.xml.bind">Unmarshaller</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>validating</code> - true if the Unmarshaller should validate during |
| unmarshal, false otherwise</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../javax/xml/bind/JAXBException.html" title="class in javax.xml.bind">JAXBException</a></code> - if an error occurred while enabling or disabling |
| validation at unmarshal time</dd></dl> |
| </li> |
| </ul> |
| <a name="getEventHandler()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEventHandler</h4> |
| <pre>public <a href="../../../../javax/xml/bind/ValidationEventHandler.html" title="interface in javax.xml.bind">ValidationEventHandler</a> getEventHandler() |
| throws <a href="../../../../javax/xml/bind/JAXBException.html" title="class in javax.xml.bind">JAXBException</a></pre> |
| <div class="block">Return the current event handler or the default event handler if one |
| hasn't been set.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../javax/xml/bind/Unmarshaller.html#getEventHandler()">getEventHandler</a></code> in interface <code><a href="../../../../javax/xml/bind/Unmarshaller.html" title="interface in javax.xml.bind">Unmarshaller</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the current ValidationEventHandler or the default event handler |
| if it hasn't been set</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../javax/xml/bind/JAXBException.html" title="class in javax.xml.bind">JAXBException</a></code> - if an error was encountered while getting the |
| current event handler</dd></dl> |
| </li> |
| </ul> |
| <a name="createUnmarshalException(org.xml.sax.SAXException)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createUnmarshalException</h4> |
| <pre>protected <a href="../../../../javax/xml/bind/UnmarshalException.html" title="class in javax.xml.bind">UnmarshalException</a> createUnmarshalException(org.xml.sax.SAXException e)</pre> |
| <div class="block">Creates an UnmarshalException from a SAXException. |
| |
| This is an utility method provided for the derived classes. |
| |
| <p> |
| 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. |
| |
| <p> |
| This method checks the nested exception of SAXException |
| and reduce those excessive wrapping.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the resulting UnmarshalException</dd></dl> |
| </li> |
| </ul> |
| <a name="setProperty(java.lang.String, java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setProperty</h4> |
| <pre>public void setProperty(java.lang.String name, |
| java.lang.Object value) |
| throws <a href="../../../../javax/xml/bind/PropertyException.html" title="class in javax.xml.bind">PropertyException</a></pre> |
| <div class="block">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.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../javax/xml/bind/Unmarshaller.html#setProperty(java.lang.String, java.lang.Object)">setProperty</a></code> in interface <code><a href="../../../../javax/xml/bind/Unmarshaller.html" title="interface in javax.xml.bind">Unmarshaller</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - 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.</dd><dd><code>value</code> - the value of the property to be set</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../javax/xml/bind/PropertyException.html" title="class in javax.xml.bind">PropertyException</a></code> - when there is an error processing the given |
| property or value</dd></dl> |
| </li> |
| </ul> |
| <a name="getProperty(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProperty</h4> |
| <pre>public java.lang.Object getProperty(java.lang.String name) |
| throws <a href="../../../../javax/xml/bind/PropertyException.html" title="class in javax.xml.bind">PropertyException</a></pre> |
| <div class="block">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.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../javax/xml/bind/Unmarshaller.html#getProperty(java.lang.String)">getProperty</a></code> in interface <code><a href="../../../../javax/xml/bind/Unmarshaller.html" title="interface in javax.xml.bind">Unmarshaller</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the property to retrieve</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the value of the requested property</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../javax/xml/bind/PropertyException.html" title="class in javax.xml.bind">PropertyException</a></code> - when there is an error retrieving the given property or value |
| property name</dd></dl> |
| </li> |
| </ul> |
| <a name="unmarshal(javax.xml.stream.XMLEventReader)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unmarshal</h4> |
| <pre>public java.lang.Object unmarshal(javax.xml.stream.XMLEventReader reader) |
| throws <a href="../../../../javax/xml/bind/JAXBException.html" title="class in javax.xml.bind">JAXBException</a></pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../javax/xml/bind/Unmarshaller.html#unmarshal(javax.xml.stream.XMLEventReader)">Unmarshaller</a></code></strong></div> |
| <div class="block">Unmarshal XML data from the specified pull parser and return the |
| resulting content tree. |
| |
| <p> |
| This method is an <a href="#unmarshalGlobal">Unmarshal Global Root method</a>. |
| |
| <p> |
| 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 <tt>reader</tt> will be pointing at |
| the token right after the end event.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../javax/xml/bind/Unmarshaller.html#unmarshal(javax.xml.stream.XMLEventReader)">unmarshal</a></code> in interface <code><a href="../../../../javax/xml/bind/Unmarshaller.html" title="interface in javax.xml.bind">Unmarshaller</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>reader</code> - The parser to be read.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the newly created root object of the java content tree.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../javax/xml/bind/JAXBException.html" title="class in javax.xml.bind">JAXBException</a></code> - If any unexpected errors occur while unmarshalling</dd> |
| <dd><code><a href="../../../../javax/xml/bind/UnmarshalException.html" title="class in javax.xml.bind">UnmarshalException</a></code> - If the <a href="../../../../javax/xml/bind/ValidationEventHandler.html" title="interface in javax.xml.bind"><code>ValidationEventHandler</code></a> |
| returns false from its <tt>handleEvent</tt> method or the |
| <tt>Unmarshaller</tt> is unable to perform the XML to Java |
| binding. See <a href="#unmarshalEx">Unmarshalling XML Data</a></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../javax/xml/bind/Unmarshaller.html#unmarshal(javax.xml.stream.XMLEventReader, java.lang.Class)"><code>Unmarshaller.unmarshal(javax.xml.stream.XMLEventReader, Class)</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="unmarshal(javax.xml.stream.XMLStreamReader)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unmarshal</h4> |
| <pre>public java.lang.Object unmarshal(javax.xml.stream.XMLStreamReader reader) |
| throws <a href="../../../../javax/xml/bind/JAXBException.html" title="class in javax.xml.bind">JAXBException</a></pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../javax/xml/bind/Unmarshaller.html#unmarshal(javax.xml.stream.XMLStreamReader)">Unmarshaller</a></code></strong></div> |
| <div class="block">Unmarshal XML data from the specified pull parser and return the |
| resulting content tree. |
| |
| <p> |
| Implements <a href="#unmarshalGlobal">Unmarshal Global Root Element</a>. |
| |
| <p> |
| 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 <tt>reader</tt> will be pointing at |
| the token right after the end event.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../javax/xml/bind/Unmarshaller.html#unmarshal(javax.xml.stream.XMLStreamReader)">unmarshal</a></code> in interface <code><a href="../../../../javax/xml/bind/Unmarshaller.html" title="interface in javax.xml.bind">Unmarshaller</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>reader</code> - The parser to be read.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the newly created root object of the java content tree.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../javax/xml/bind/JAXBException.html" title="class in javax.xml.bind">JAXBException</a></code> - If any unexpected errors occur while unmarshalling</dd> |
| <dd><code><a href="../../../../javax/xml/bind/UnmarshalException.html" title="class in javax.xml.bind">UnmarshalException</a></code> - If the <a href="../../../../javax/xml/bind/ValidationEventHandler.html" title="interface in javax.xml.bind"><code>ValidationEventHandler</code></a> |
| returns false from its <tt>handleEvent</tt> method or the |
| <tt>Unmarshaller</tt> is unable to perform the XML to Java |
| binding. See <a href="#unmarshalEx">Unmarshalling XML Data</a></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../javax/xml/bind/Unmarshaller.html#unmarshal(javax.xml.stream.XMLStreamReader, java.lang.Class)"><code>Unmarshaller.unmarshal(javax.xml.stream.XMLStreamReader, Class)</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="unmarshal(org.w3c.dom.Node, java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unmarshal</h4> |
| <pre>public <T> <a href="../../../../javax/xml/bind/JAXBElement.html" title="class in javax.xml.bind">JAXBElement</a><T> unmarshal(org.w3c.dom.Node node, |
| java.lang.Class<T> expectedType) |
| throws <a href="../../../../javax/xml/bind/JAXBException.html" title="class in javax.xml.bind">JAXBException</a></pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../javax/xml/bind/Unmarshaller.html#unmarshal(org.w3c.dom.Node, java.lang.Class)">Unmarshaller</a></code></strong></div> |
| <div class="block">Unmarshal XML data by JAXB mapped <tt>declaredType</tt> |
| and return the resulting content tree. |
| |
| <p> |
| Implements <a href="#unmarshalByDeclaredType">Unmarshal by Declared Type</a></div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../javax/xml/bind/Unmarshaller.html#unmarshal(org.w3c.dom.Node, java.lang.Class)">unmarshal</a></code> in interface <code><a href="../../../../javax/xml/bind/Unmarshaller.html" title="interface in javax.xml.bind">Unmarshaller</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>node</code> - the document/element to unmarshal XML data from. |
| The caller must support at least Document and Element.</dd><dd><code>expectedType</code> - appropriate JAXB mapped class to hold <tt>node</tt>'s XML data.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd><a href="#unmarshalDeclaredTypeReturn">JAXB Element</a> representation of <tt>node</tt></dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../javax/xml/bind/JAXBException.html" title="class in javax.xml.bind">JAXBException</a></code> - If any unexpected errors occur while unmarshalling</dd> |
| <dd><code><a href="../../../../javax/xml/bind/UnmarshalException.html" title="class in javax.xml.bind">UnmarshalException</a></code> - If the <a href="../../../../javax/xml/bind/ValidationEventHandler.html" title="interface in javax.xml.bind"><code>ValidationEventHandler</code></a> |
| returns false from its <tt>handleEvent</tt> method or the |
| <tt>Unmarshaller</tt> is unable to perform the XML to Java |
| binding. See <a href="#unmarshalEx">Unmarshalling XML Data</a></dd></dl> |
| </li> |
| </ul> |
| <a name="unmarshal(javax.xml.transform.Source, java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unmarshal</h4> |
| <pre>public <T> <a href="../../../../javax/xml/bind/JAXBElement.html" title="class in javax.xml.bind">JAXBElement</a><T> unmarshal(javax.xml.transform.Source source, |
| java.lang.Class<T> expectedType) |
| throws <a href="../../../../javax/xml/bind/JAXBException.html" title="class in javax.xml.bind">JAXBException</a></pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../javax/xml/bind/Unmarshaller.html#unmarshal(javax.xml.transform.Source, java.lang.Class)">Unmarshaller</a></code></strong></div> |
| <div class="block">Unmarshal XML data from the specified XML Source by <tt>declaredType</tt> and return the |
| resulting content tree. |
| |
| <p> |
| Implements <a href="#unmarshalByDeclaredType">Unmarshal by Declared Type</a> |
| |
| <p> |
| See <a href="#saxParserPlugable">SAX 2.0 Parser Pluggability</a></div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../javax/xml/bind/Unmarshaller.html#unmarshal(javax.xml.transform.Source, java.lang.Class)">unmarshal</a></code> in interface <code><a href="../../../../javax/xml/bind/Unmarshaller.html" title="interface in javax.xml.bind">Unmarshaller</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>source</code> - the XML Source to unmarshal XML data from (providers are |
| only required to support SAXSource, DOMSource, and StreamSource)</dd><dd><code>expectedType</code> - appropriate JAXB mapped class to hold <tt>source</tt>'s xml root element</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>Java content rooted by <a href="#unmarshalDeclaredTypeReturn">JAXB Element</a></dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../javax/xml/bind/JAXBException.html" title="class in javax.xml.bind">JAXBException</a></code> - If any unexpected errors occur while unmarshalling</dd> |
| <dd><code><a href="../../../../javax/xml/bind/UnmarshalException.html" title="class in javax.xml.bind">UnmarshalException</a></code> - If the <a href="../../../../javax/xml/bind/ValidationEventHandler.html" title="interface in javax.xml.bind"><code>ValidationEventHandler</code></a> |
| returns false from its <tt>handleEvent</tt> method or the |
| <tt>Unmarshaller</tt> is unable to perform the XML to Java |
| binding. See <a href="#unmarshalEx">Unmarshalling XML Data</a></dd></dl> |
| </li> |
| </ul> |
| <a name="unmarshal(javax.xml.stream.XMLStreamReader, java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unmarshal</h4> |
| <pre>public <T> <a href="../../../../javax/xml/bind/JAXBElement.html" title="class in javax.xml.bind">JAXBElement</a><T> unmarshal(javax.xml.stream.XMLStreamReader reader, |
| java.lang.Class<T> expectedType) |
| throws <a href="../../../../javax/xml/bind/JAXBException.html" title="class in javax.xml.bind">JAXBException</a></pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../javax/xml/bind/Unmarshaller.html#unmarshal(javax.xml.stream.XMLStreamReader, java.lang.Class)">Unmarshaller</a></code></strong></div> |
| <div class="block">Unmarshal root element to JAXB mapped <tt>declaredType</tt> |
| and return the resulting content tree. |
| |
| <p> |
| This method implements <a href="unmarshalByDeclaredType">unmarshal by declaredType</a>. |
| <p> |
| 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 <tt>reader</tt> will be pointing at |
| the token right after the end event.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../javax/xml/bind/Unmarshaller.html#unmarshal(javax.xml.stream.XMLStreamReader, java.lang.Class)">unmarshal</a></code> in interface <code><a href="../../../../javax/xml/bind/Unmarshaller.html" title="interface in javax.xml.bind">Unmarshaller</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>reader</code> - The parser to be read.</dd><dd><code>expectedType</code> - appropriate JAXB mapped class to hold <tt>reader</tt>'s START_ELEMENT XML data.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>content tree rooted by <a href="#unmarshalDeclaredTypeReturn">JAXB Element representation</a></dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../javax/xml/bind/JAXBException.html" title="class in javax.xml.bind">JAXBException</a></code> - If any unexpected errors occur while unmarshalling</dd> |
| <dd><code><a href="../../../../javax/xml/bind/UnmarshalException.html" title="class in javax.xml.bind">UnmarshalException</a></code> - If the <a href="../../../../javax/xml/bind/ValidationEventHandler.html" title="interface in javax.xml.bind"><code>ValidationEventHandler</code></a> |
| returns false from its <tt>handleEvent</tt> method or the |
| <tt>Unmarshaller</tt> is unable to perform the XML to Java |
| binding. See <a href="#unmarshalEx">Unmarshalling XML Data</a></dd></dl> |
| </li> |
| </ul> |
| <a name="unmarshal(javax.xml.stream.XMLEventReader, java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unmarshal</h4> |
| <pre>public <T> <a href="../../../../javax/xml/bind/JAXBElement.html" title="class in javax.xml.bind">JAXBElement</a><T> unmarshal(javax.xml.stream.XMLEventReader reader, |
| java.lang.Class<T> expectedType) |
| throws <a href="../../../../javax/xml/bind/JAXBException.html" title="class in javax.xml.bind">JAXBException</a></pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../javax/xml/bind/Unmarshaller.html#unmarshal(javax.xml.stream.XMLEventReader, java.lang.Class)">Unmarshaller</a></code></strong></div> |
| <div class="block">Unmarshal root element to JAXB mapped <tt>declaredType</tt> |
| and return the resulting content tree. |
| |
| <p> |
| This method implements <a href="unmarshalByDeclaredType">unmarshal by declaredType</a>. |
| |
| <p> |
| 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 <tt>reader</tt> will be pointing at |
| the token right after the end event.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../javax/xml/bind/Unmarshaller.html#unmarshal(javax.xml.stream.XMLEventReader, java.lang.Class)">unmarshal</a></code> in interface <code><a href="../../../../javax/xml/bind/Unmarshaller.html" title="interface in javax.xml.bind">Unmarshaller</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>reader</code> - The parser to be read.</dd><dd><code>expectedType</code> - appropriate JAXB mapped class to hold <tt>reader</tt>'s START_ELEMENT XML data.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>content tree rooted by <a href="#unmarshalDeclaredTypeReturn">JAXB Element representation</a></dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../javax/xml/bind/JAXBException.html" title="class in javax.xml.bind">JAXBException</a></code> - If any unexpected errors occur while unmarshalling</dd> |
| <dd><code><a href="../../../../javax/xml/bind/UnmarshalException.html" title="class in javax.xml.bind">UnmarshalException</a></code> - If the <a href="../../../../javax/xml/bind/ValidationEventHandler.html" title="interface in javax.xml.bind"><code>ValidationEventHandler</code></a> |
| returns false from its <tt>handleEvent</tt> method or the |
| <tt>Unmarshaller</tt> is unable to perform the XML to Java |
| binding. See <a href="#unmarshalEx">Unmarshalling XML Data</a></dd></dl> |
| </li> |
| </ul> |
| <a name="setSchema(javax.xml.validation.Schema)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSchema</h4> |
| <pre>public void setSchema(javax.xml.validation.Schema schema)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../javax/xml/bind/Unmarshaller.html#setSchema(javax.xml.validation.Schema)">Unmarshaller</a></code></strong></div> |
| <div class="block">Specify the JAXP 1.3 <code>Schema</code> |
| object that should be used to validate subsequent unmarshal operations |
| against. Passing null into this method will disable validation. |
| <p> |
| This method replaces the deprecated <a href="../../../../javax/xml/bind/Unmarshaller.html#setValidating(boolean)"><code>setValidating(boolean)</code></a> |
| API. |
| |
| <p> |
| Initially this property is set to <tt>null</tt>.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../javax/xml/bind/Unmarshaller.html#setSchema(javax.xml.validation.Schema)">setSchema</a></code> in interface <code><a href="../../../../javax/xml/bind/Unmarshaller.html" title="interface in javax.xml.bind">Unmarshaller</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>schema</code> - Schema object to validate unmarshal operations against or null to disable validation</dd></dl> |
| </li> |
| </ul> |
| <a name="getSchema()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSchema</h4> |
| <pre>public javax.xml.validation.Schema getSchema()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../javax/xml/bind/Unmarshaller.html#getSchema()">Unmarshaller</a></code></strong></div> |
| <div class="block">Get the JAXP 1.3 <code>Schema</code> 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. |
| <p> |
| This method provides replacement functionality for the deprecated |
| <a href="../../../../javax/xml/bind/Unmarshaller.html#isValidating()"><code>Unmarshaller.isValidating()</code></a> API as well as access to the Schema object. |
| To determine if the Unmarshaller has validation enabled, simply |
| test the return type for null: |
| <p> |
| <code> |
| boolean isValidating = u.getSchema()!=null; |
| </code></div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../javax/xml/bind/Unmarshaller.html#getSchema()">getSchema</a></code> in interface <code><a href="../../../../javax/xml/bind/Unmarshaller.html" title="interface in javax.xml.bind">Unmarshaller</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the Schema object being used to perform unmarshal-time |
| validation or null if not present</dd></dl> |
| </li> |
| </ul> |
| <a name="setAdapter(javax.xml.bind.annotation.adapters.XmlAdapter)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAdapter</h4> |
| <pre>public void setAdapter(<a href="../../../../javax/xml/bind/annotation/adapters/XmlAdapter.html" title="class in javax.xml.bind.annotation.adapters">XmlAdapter</a> adapter)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../javax/xml/bind/Unmarshaller.html#setAdapter(javax.xml.bind.annotation.adapters.XmlAdapter)">Unmarshaller</a></code></strong></div> |
| <div class="block">Associates a configured instance of <a href="../../../../javax/xml/bind/annotation/adapters/XmlAdapter.html" title="class in javax.xml.bind.annotation.adapters"><code>XmlAdapter</code></a> with this unmarshaller. |
| |
| <p> |
| This is a convenience method that invokes <code>setAdapter(adapter.getClass(),adapter);</code>.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../javax/xml/bind/Unmarshaller.html#setAdapter(javax.xml.bind.annotation.adapters.XmlAdapter)">setAdapter</a></code> in interface <code><a href="../../../../javax/xml/bind/Unmarshaller.html" title="interface in javax.xml.bind">Unmarshaller</a></code></dd> |
| <dt><span class="strong">See Also:</span></dt><dd><a href="../../../../javax/xml/bind/Unmarshaller.html#setAdapter(java.lang.Class, A)"><code>Unmarshaller.setAdapter(Class,XmlAdapter)</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="setAdapter(java.lang.Class,javax.xml.bind.annotation.adapters.XmlAdapter)"> |
| <!-- --> |
| </a><a name="setAdapter(java.lang.Class, A)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAdapter</h4> |
| <pre>public <A extends <a href="../../../../javax/xml/bind/annotation/adapters/XmlAdapter.html" title="class in javax.xml.bind.annotation.adapters">XmlAdapter</a>> void setAdapter(java.lang.Class<A> type, |
| A adapter)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../javax/xml/bind/Unmarshaller.html#setAdapter(java.lang.Class, A)">Unmarshaller</a></code></strong></div> |
| <div class="block">Associates a configured instance of <a href="../../../../javax/xml/bind/annotation/adapters/XmlAdapter.html" title="class in javax.xml.bind.annotation.adapters"><code>XmlAdapter</code></a> with this unmarshaller. |
| |
| <p> |
| Every unmarshaller internally maintains a |
| <code>Map</code><<code>Class</code>,<a href="../../../../javax/xml/bind/annotation/adapters/XmlAdapter.html" title="class in javax.xml.bind.annotation.adapters"><code>XmlAdapter</code></a>>, |
| which it uses for unmarshalling classes whose fields/methods are annotated |
| with <a href="../../../../javax/xml/bind/annotation/adapters/XmlJavaTypeAdapter.html" title="annotation in javax.xml.bind.annotation.adapters"><code>XmlJavaTypeAdapter</code></a>. |
| |
| <p> |
| This method allows applications to use a configured instance of <a href="../../../../javax/xml/bind/annotation/adapters/XmlAdapter.html" title="class in javax.xml.bind.annotation.adapters"><code>XmlAdapter</code></a>. |
| When an instance of an adapter is not given, an unmarshaller will create |
| one by invoking its default constructor.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../javax/xml/bind/Unmarshaller.html#setAdapter(java.lang.Class, A)">setAdapter</a></code> in interface <code><a href="../../../../javax/xml/bind/Unmarshaller.html" title="interface in javax.xml.bind">Unmarshaller</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - The type of the adapter. The specified instance will be used when |
| <a href="../../../../javax/xml/bind/annotation/adapters/XmlJavaTypeAdapter.html#value()"><code>XmlJavaTypeAdapter.value()</code></a> |
| refers to this type.</dd><dd><code>adapter</code> - The instance of the adapter to be used. If null, it will un-register |
| the current adapter set for this type.</dd></dl> |
| </li> |
| </ul> |
| <a name="getAdapter(java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAdapter</h4> |
| <pre>public <A extends <a href="../../../../javax/xml/bind/annotation/adapters/XmlAdapter.html" title="class in javax.xml.bind.annotation.adapters">XmlAdapter</a>> A getAdapter(java.lang.Class<A> type)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../javax/xml/bind/Unmarshaller.html#getAdapter(java.lang.Class)">Unmarshaller</a></code></strong></div> |
| <div class="block">Gets the adapter associated with the specified type. |
| |
| This is the reverse operation of the <a href="../../../../javax/xml/bind/Unmarshaller.html#setAdapter(javax.xml.bind.annotation.adapters.XmlAdapter)"><code>Unmarshaller.setAdapter(javax.xml.bind.annotation.adapters.XmlAdapter)</code></a> method.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../javax/xml/bind/Unmarshaller.html#getAdapter(java.lang.Class)">getAdapter</a></code> in interface <code><a href="../../../../javax/xml/bind/Unmarshaller.html" title="interface in javax.xml.bind">Unmarshaller</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setAttachmentUnmarshaller(javax.xml.bind.attachment.AttachmentUnmarshaller)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAttachmentUnmarshaller</h4> |
| <pre>public void setAttachmentUnmarshaller(<a href="../../../../javax/xml/bind/attachment/AttachmentUnmarshaller.html" title="class in javax.xml.bind.attachment">AttachmentUnmarshaller</a> au)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../javax/xml/bind/Unmarshaller.html#setAttachmentUnmarshaller(javax.xml.bind.attachment.AttachmentUnmarshaller)">Unmarshaller</a></code></strong></div> |
| <div class="block"><p>Associate a context that resolves cid's, content-id URIs, to |
| binary data passed as attachments.</p> |
| <p/> |
| <p>Unmarshal time validation, enabled via <a href="../../../../javax/xml/bind/Unmarshaller.html#setSchema(javax.xml.validation.Schema)"><code>Unmarshaller.setSchema(Schema)</code></a>, |
| must be supported even when unmarshaller is performing XOP processing. |
| </p></div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../javax/xml/bind/Unmarshaller.html#setAttachmentUnmarshaller(javax.xml.bind.attachment.AttachmentUnmarshaller)">setAttachmentUnmarshaller</a></code> in interface <code><a href="../../../../javax/xml/bind/Unmarshaller.html" title="interface in javax.xml.bind">Unmarshaller</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAttachmentUnmarshaller()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAttachmentUnmarshaller</h4> |
| <pre>public <a href="../../../../javax/xml/bind/attachment/AttachmentUnmarshaller.html" title="class in javax.xml.bind.attachment">AttachmentUnmarshaller</a> getAttachmentUnmarshaller()</pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../javax/xml/bind/Unmarshaller.html#getAttachmentUnmarshaller()">getAttachmentUnmarshaller</a></code> in interface <code><a href="../../../../javax/xml/bind/Unmarshaller.html" title="interface in javax.xml.bind">Unmarshaller</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setListener(javax.xml.bind.Unmarshaller.Listener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setListener</h4> |
| <pre>public void setListener(<a href="../../../../javax/xml/bind/Unmarshaller.Listener.html" title="class in javax.xml.bind">Unmarshaller.Listener</a> listener)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../javax/xml/bind/Unmarshaller.html#setListener(javax.xml.bind.Unmarshaller.Listener)">Unmarshaller</a></code></strong></div> |
| <div class="block"><p> |
| Register unmarshal event callback <a href="../../../../javax/xml/bind/Unmarshaller.Listener.html" title="class in javax.xml.bind"><code>Unmarshaller.Listener</code></a> with this <a href="../../../../javax/xml/bind/Unmarshaller.html" title="interface in javax.xml.bind"><code>Unmarshaller</code></a>. |
| |
| <p> |
| There is only one Listener per Unmarshaller. Setting a Listener replaces the previous set Listener. |
| One can unregister current Listener by setting listener to <tt>null</tt>.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../javax/xml/bind/Unmarshaller.html#setListener(javax.xml.bind.Unmarshaller.Listener)">setListener</a></code> in interface <code><a href="../../../../javax/xml/bind/Unmarshaller.html" title="interface in javax.xml.bind">Unmarshaller</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>listener</code> - provides unmarshal event callbacks for this <a href="../../../../javax/xml/bind/Unmarshaller.html" title="interface in javax.xml.bind"><code>Unmarshaller</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="getListener()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getListener</h4> |
| <pre>public <a href="../../../../javax/xml/bind/Unmarshaller.Listener.html" title="class in javax.xml.bind">Unmarshaller.Listener</a> getListener()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../javax/xml/bind/Unmarshaller.html#getListener()">Unmarshaller</a></code></strong></div> |
| <div class="block"><p>Return <a href="../../../../javax/xml/bind/Unmarshaller.Listener.html" title="class in javax.xml.bind"><code>Unmarshaller.Listener</code></a> registered with this <a href="../../../../javax/xml/bind/Unmarshaller.html" title="interface in javax.xml.bind"><code>Unmarshaller</code></a>.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../javax/xml/bind/Unmarshaller.html#getListener()">getListener</a></code> in interface <code><a href="../../../../javax/xml/bind/Unmarshaller.html" title="interface in javax.xml.bind">Unmarshaller</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>registered <a href="../../../../javax/xml/bind/Unmarshaller.Listener.html" title="class in javax.xml.bind"><code>Unmarshaller.Listener</code></a> or <code>null</code> if no Listener is registered with this Unmarshaller.</dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><em>EclipseLink 2.5.1, build 'v20130918-f2b9fc5' API Reference</em></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../javax/xml/bind/helpers/AbstractMarshallerImpl.html" title="class in javax.xml.bind.helpers"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../javax/xml/bind/helpers/DefaultValidationEventHandler.html" title="class in javax.xml.bind.helpers"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?javax/xml/bind/helpers/AbstractUnmarshallerImpl.html" target="_top">Frames</a></li> |
| <li><a href="AbstractUnmarshallerImpl.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field_summary">Field</a> | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </li> |
| <li><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |