| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.2) on Wed Apr 22 10:19:16 CDT 2020 --> |
| <title>jakarta.xml.bind (EclipseLink 3.0.0, API Reference)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2020-04-22"> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../script.js"></script> |
| <script type="text/javascript" src="../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../jquery/jquery-3.3.1.js"></script> |
| <script type="text/javascript" src="../../../jquery/jquery-migrate-3.0.1.js"></script> |
| <script type="text/javascript" src="../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="jakarta.xml.bind (EclipseLink 3.0.0, API Reference)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var pathtoroot = "../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../index.html">Overview</a></li> |
| <li class="navBarCell1Rev">Package</li> |
| <li>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">EclipseLink 3.0.0, API Reference</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <main role="main"> |
| <div class="header"> |
| <h1 title="Package" class="title">Package jakarta.xml.bind</h1> |
| </div> |
| <div class="contentContainer"> |
| <section role="region"><a id="package.description"> |
| <!-- --> |
| </a> |
| <div class="block">Provides a runtime binding framework for client applications including |
| unmarshalling, marshalling, and validation capabilities. |
| <p> |
| <p> |
| <code>JAXBContext</code> is the client-entry point to the runtime binding |
| framework. |
| <p> |
| <p> |
| References in this document to JAXB refer to the Jakarta XML Binding unless otherwise noted. |
| |
| <h2>Package Specification</h2> |
| <p> |
| <ul> |
| <li><a href="https://projects.eclipse.org/projects/ee4j.jaxb">Jakarta XML Binding Specification project</a> |
| </ul> |
| <p> |
| <h2>Related Documentation</h2> |
| <p> |
| For overviews, tutorials, examples, guides, and tool documentation, |
| please see: |
| <ul> |
| <li>The <a href="https://projects.eclipse.org/projects/ee4j.jaxb">Jakarta XML Binding Website</a> |
| </ul></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="https://projects.eclipse.org/projects/ee4j.jaxb">Jakarta XML Binding Website</a></dd> |
| </dl> |
| </section> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="DatatypeConverterInterface.html" title="interface in jakarta.xml.bind">DatatypeConverterInterface</a></th> |
| <td class="colLast"> |
| <div class="block"> |
| The DatatypeConverterInterface is for JAXB provider use only.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="Element.html" title="interface in jakarta.xml.bind">Element</a></th> |
| <td class="colLast"> |
| <div class="block">This is an element marker interface.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="JAXBContextFactory.html" title="interface in jakarta.xml.bind">JAXBContextFactory</a></th> |
| <td class="colLast"> |
| <div class="block">Factory that creates new <code>JAXBContext</code> instances.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="Marshaller.html" title="interface in jakarta.xml.bind">Marshaller</a></th> |
| <td class="colLast"> |
| <div class="block"> |
| The <code>Marshaller</code> class is responsible for governing the process |
| of serializing Java content trees back into XML data.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="NotIdentifiableEvent.html" title="interface in jakarta.xml.bind">NotIdentifiableEvent</a></th> |
| <td class="colLast"> |
| <div class="block">This event indicates that a problem was encountered resolving an ID/IDREF.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="ParseConversionEvent.html" title="interface in jakarta.xml.bind">ParseConversionEvent</a></th> |
| <td class="colLast"> |
| <div class="block">This event indicates that a problem was encountered while converting a |
| string from the XML data into a value of the target Java data type.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="PrintConversionEvent.html" title="interface in jakarta.xml.bind">PrintConversionEvent</a></th> |
| <td class="colLast"> |
| <div class="block">This event indicates that a problem was encountered while converting data |
| from the Java content tree into its lexical representation.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="Unmarshaller.html" title="interface in jakarta.xml.bind">Unmarshaller</a></th> |
| <td class="colLast"> |
| <div class="block">The <code>Unmarshaller</code> class governs the process of deserializing XML |
| data into newly created Java content trees, optionally validating the XML |
| data as it is unmarshalled.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="UnmarshallerHandler.html" title="interface in jakarta.xml.bind">UnmarshallerHandler</a></th> |
| <td class="colLast"> |
| <div class="block">Unmarshaller implemented as SAX ContentHandler.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="ValidationEvent.html" title="interface in jakarta.xml.bind">ValidationEvent</a></th> |
| <td class="colLast"> |
| <div class="block">This event indicates that a problem was encountered while validating the |
| incoming XML data during an unmarshal operation, while performing |
| on-demand validation of the Java content tree, or while marshalling the |
| Java content tree back to XML data.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="ValidationEventHandler.html" title="interface in jakarta.xml.bind">ValidationEventHandler</a></th> |
| <td class="colLast"> |
| <div class="block">A basic event handler interface for validation errors.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="ValidationEventLocator.html" title="interface in jakarta.xml.bind">ValidationEventLocator</a></th> |
| <td class="colLast"> |
| <div class="block">Encapsulate the location of a ValidationEvent.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="Validator.html" title="interface in jakarta.xml.bind">Validator</a></th> |
| <td class="colLast">Deprecated. |
| <div class="deprecationComment">since JAXB 2.0</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="Binder.html" title="class in jakarta.xml.bind">Binder</a><XmlNode></th> |
| <td class="colLast"> |
| <div class="block">Enable synchronization between XML infoset nodes and JAXB objects |
| representing same XML document.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="DatatypeConverter.html" title="class in jakarta.xml.bind">DatatypeConverter</a></th> |
| <td class="colLast"> |
| <div class="block"> |
| The javaType binding declaration can be used to customize the binding of |
| an XML schema datatype to a Java datatype.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="JAXB.html" title="class in jakarta.xml.bind">JAXB</a></th> |
| <td class="colLast"> |
| <div class="block">Class that defines convenience methods for common, simple use of JAXB.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="JAXBContext.html" title="class in jakarta.xml.bind">JAXBContext</a></th> |
| <td class="colLast"> |
| <div class="block">The <code>JAXBContext</code> class provides the client's entry point to the |
| JAXB API.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="JAXBElement.html" title="class in jakarta.xml.bind">JAXBElement</a><T></th> |
| <td class="colLast"> |
| <div class="block">JAXB representation of an Xml Element.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="JAXBElement.GlobalScope.html" title="class in jakarta.xml.bind">JAXBElement.GlobalScope</a></th> |
| <td class="colLast"> |
| <div class="block">Designates global scope for an xml element.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="JAXBIntrospector.html" title="class in jakarta.xml.bind">JAXBIntrospector</a></th> |
| <td class="colLast"> |
| <div class="block">Provide access to JAXB xml binding data for a JAXB object.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="JAXBPermission.html" title="class in jakarta.xml.bind">JAXBPermission</a></th> |
| <td class="colLast"> |
| <div class="block">This class is for JAXB permissions.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="Marshaller.Listener.html" title="class in jakarta.xml.bind">Marshaller.Listener</a></th> |
| <td class="colLast"> |
| <div class="block"> |
| Register an instance of an implementation of this class with a <a href="Marshaller.html" title="interface in jakarta.xml.bind"><code>Marshaller</code></a> to externally listen |
| for marshal events.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SchemaOutputResolver.html" title="class in jakarta.xml.bind">SchemaOutputResolver</a></th> |
| <td class="colLast"> |
| <div class="block">Controls where a JAXB implementation puts the generates |
| schema files.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="Unmarshaller.Listener.html" title="class in jakarta.xml.bind">Unmarshaller.Listener</a></th> |
| <td class="colLast"> |
| <div class="block"> |
| Register an instance of an implementation of this class with <a href="Unmarshaller.html" title="interface in jakarta.xml.bind"><code>Unmarshaller</code></a> to externally listen |
| for unmarshal events.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <caption><span>Exception Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Exception</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="DataBindingException.html" title="class in jakarta.xml.bind">DataBindingException</a></th> |
| <td class="colLast"> |
| <div class="block">Exception that represents a failure in a JAXB operation.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="JAXBException.html" title="class in jakarta.xml.bind">JAXBException</a></th> |
| <td class="colLast"> |
| <div class="block">This is the root exception class for all JAXB exceptions.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="MarshalException.html" title="class in jakarta.xml.bind">MarshalException</a></th> |
| <td class="colLast"> |
| <div class="block">This exception indicates that an error has occurred while performing |
| a marshal operation that the provider is unable to recover from.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="PropertyException.html" title="class in jakarta.xml.bind">PropertyException</a></th> |
| <td class="colLast"> |
| <div class="block">This exception indicates that an error was encountered while getting or |
| setting a property.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="TypeConstraintException.html" title="class in jakarta.xml.bind">TypeConstraintException</a></th> |
| <td class="colLast"> |
| <div class="block">This exception indicates that a violation of a dynamically checked type |
| constraint was detected.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="UnmarshalException.html" title="class in jakarta.xml.bind">UnmarshalException</a></th> |
| <td class="colLast"> |
| <div class="block">This exception indicates that an error has occurred while performing |
| an unmarshal operation that prevents the JAXB Provider from completing |
| the operation.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="ValidationException.html" title="class in jakarta.xml.bind">ValidationException</a></th> |
| <td class="colLast"> |
| <div class="block">This exception indicates that an error has occurred while performing |
| a validate operation.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| </div> |
| </main> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../index.html">Overview</a></li> |
| <li class="navBarCell1Rev">Package</li> |
| <li>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">EclipseLink 3.0.0, API Reference</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../allclasses.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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2017–2020 <a href="http://www.eclipse.org/eclipselink">Eclipse.org - EclipseLink Project</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
