| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.2) on Wed Apr 22 10:19:16 CDT 2020 --> |
| <title>JAXB (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="JAXB (EclipseLink 3.0.0, API Reference)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9,"i11":9,"i12":9,"i13":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| 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><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">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> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </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> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">jakarta.xml.bind</a></div> |
| <h2 title="Class JAXB" class="title">Class JAXB</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>jakarta.xml.bind.JAXB</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <pre>public final class <span class="typeNameLabel">JAXB</span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></pre> |
| <div class="block">Class that defines convenience methods for common, simple use of JAXB. |
| |
| <p> |
| Methods defined in this class are convenience methods that combine several basic operations |
| in the <a href="JAXBContext.html" title="class in jakarta.xml.bind"><code>JAXBContext</code></a>, <a href="Unmarshaller.html" title="interface in jakarta.xml.bind"><code>Unmarshaller</code></a>, and <a href="Marshaller.html" title="interface in jakarta.xml.bind"><code>Marshaller</code></a>. |
| |
| They are designed |
| to be the prefered methods for developers new to JAXB. They have |
| the following characterstics: |
| |
| <ol> |
| <li>Generally speaking, the performance is not necessarily optimal. |
| It is expected that people who need to write performance |
| critical code will use the rest of the JAXB API directly. |
| <li>Errors that happen during the processing is wrapped into |
| <a href="DataBindingException.html" title="class in jakarta.xml.bind"><code>DataBindingException</code></a> (which will have <a href="JAXBException.html" title="class in jakarta.xml.bind"><code>JAXBException</code></a> |
| as its <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getCause()" title="class or interface in java.lang" class="externalLink"><code>cause</code></a>. It is expected that |
| people who prefer the checked exception would use |
| the rest of the JAXB API directly. |
| </ol> |
| |
| <p> |
| In addition, the <code>unmarshal</code> methods have the following characteristic: |
| |
| <ol> |
| <li>Schema validation is not performed on the input XML. |
| The processing will try to continue even if there |
| are errors in the XML, as much as possible. Only as |
| the last resort, this method fails with <a href="DataBindingException.html" title="class in jakarta.xml.bind"><code>DataBindingException</code></a>. |
| </ol> |
| |
| <p> |
| Similarly, the <code>marshal</code> methods have the following characteristic: |
| <ol> |
| <li>The processing will try to continue even if the Java object tree |
| does not meet the validity requirement. Only as |
| the last resort, this method fails with <a href="DataBindingException.html" title="class in jakarta.xml.bind"><code>DataBindingException</code></a>. |
| </ol> |
| |
| |
| <p> |
| All the methods on this class require non-null arguments to all parameters. |
| The <code>unmarshal</code> methods either fail with an exception or return |
| a non-null value.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd>Kohsuke Kawaguchi</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6, JAXB 2.1</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#marshal(java.lang.Object,java.io.File)">marshal</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> jaxbObject, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io" class="externalLink">File</a> xml)</code></th> |
| <td class="colLast"> |
| <div class="block">Writes a Java object tree to XML and store it to the specified location.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#marshal(java.lang.Object,java.io.OutputStream)">marshal</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> jaxbObject, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">OutputStream</a> xml)</code></th> |
| <td class="colLast"> |
| <div class="block">Writes a Java object tree to XML and store it to the specified location.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#marshal(java.lang.Object,java.io.Writer)">marshal</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> jaxbObject, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io" class="externalLink">Writer</a> xml)</code></th> |
| <td class="colLast"> |
| <div class="block">Writes a Java object tree to XML and store it to the specified location.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#marshal(java.lang.Object,java.lang.String)">marshal</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> jaxbObject, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> xml)</code></th> |
| <td class="colLast"> |
| <div class="block">Writes a Java object tree to XML and store it to the specified location.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#marshal(java.lang.Object,java.net.URI)">marshal</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> jaxbObject, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink">URI</a> xml)</code></th> |
| <td class="colLast"> |
| <div class="block">Writes a Java object tree to XML and store it to the specified location.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#marshal(java.lang.Object,java.net.URL)">marshal</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> jaxbObject, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net" class="externalLink">URL</a> xml)</code></th> |
| <td class="colLast"> |
| <div class="block">Writes a Java object tree to XML and store it to the specified location.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#marshal(java.lang.Object,javax.xml.transform.Result)">marshal</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> jaxbObject, |
| <a href="https://docs.oracle.com/javase/8/docs/api/javax/xml/transform/Result.html?is-external=true" title="class or interface in javax.xml.transform" class="externalLink">Result</a> xml)</code></th> |
| <td class="colLast"> |
| <div class="block">Writes a Java object tree to XML and store it to the specified location.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>static <T> T</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#unmarshal(java.io.File,java.lang.Class)">unmarshal</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io" class="externalLink">File</a> xml, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><T> type)</code></th> |
| <td class="colLast"> |
| <div class="block">Reads in a Java object tree from the given XML input.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>static <T> T</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#unmarshal(java.io.InputStream,java.lang.Class)">unmarshal</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">InputStream</a> xml, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><T> type)</code></th> |
| <td class="colLast"> |
| <div class="block">Reads in a Java object tree from the given XML input.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>static <T> T</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#unmarshal(java.io.Reader,java.lang.Class)">unmarshal</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io" class="externalLink">Reader</a> xml, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><T> type)</code></th> |
| <td class="colLast"> |
| <div class="block">Reads in a Java object tree from the given XML input.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>static <T> T</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#unmarshal(java.lang.String,java.lang.Class)">unmarshal</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> xml, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><T> type)</code></th> |
| <td class="colLast"> |
| <div class="block">Reads in a Java object tree from the given XML input.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>static <T> T</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#unmarshal(java.net.URI,java.lang.Class)">unmarshal</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink">URI</a> xml, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><T> type)</code></th> |
| <td class="colLast"> |
| <div class="block">Reads in a Java object tree from the given XML input.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>static <T> T</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#unmarshal(java.net.URL,java.lang.Class)">unmarshal</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net" class="externalLink">URL</a> xml, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><T> type)</code></th> |
| <td class="colLast"> |
| <div class="block">Reads in a Java object tree from the given XML input.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>static <T> T</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#unmarshal(javax.xml.transform.Source,java.lang.Class)">unmarshal</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/javax/xml/transform/Source.html?is-external=true" title="class or interface in javax.xml.transform" class="externalLink">Source</a> xml, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><T> type)</code></th> |
| <td class="colLast"> |
| <div class="block">Reads in a Java object tree from the given XML input.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="unmarshal(java.io.File,java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unmarshal</h4> |
| <pre class="methodSignature">public static <T> T unmarshal​(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io" class="externalLink">File</a> xml, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><T> type)</pre> |
| <div class="block">Reads in a Java object tree from the given XML input.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>xml</code> - Reads the entire file as XML.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="unmarshal(java.net.URL,java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unmarshal</h4> |
| <pre class="methodSignature">public static <T> T unmarshal​(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net" class="externalLink">URL</a> xml, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><T> type)</pre> |
| <div class="block">Reads in a Java object tree from the given XML input.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>xml</code> - The resource pointed by the URL is read in its entirety.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="unmarshal(java.net.URI,java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unmarshal</h4> |
| <pre class="methodSignature">public static <T> T unmarshal​(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink">URI</a> xml, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><T> type)</pre> |
| <div class="block">Reads in a Java object tree from the given XML input.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>xml</code> - The URI is <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true#toURL()" title="class or interface in java.net" class="externalLink"><code>turned into URL</code></a> and then |
| follows the handling of <code>URL</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="unmarshal(java.lang.String,java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unmarshal</h4> |
| <pre class="methodSignature">public static <T> T unmarshal​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> xml, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><T> type)</pre> |
| <div class="block">Reads in a Java object tree from the given XML input.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>xml</code> - The string is first interpreted as an absolute <code>URI</code>. |
| If it's not <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true#isAbsolute()" title="class or interface in java.net" class="externalLink"><code>a valid absolute URI</code></a>, |
| then it's interpreted as a <code>File</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="unmarshal(java.io.InputStream,java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unmarshal</h4> |
| <pre class="methodSignature">public static <T> T unmarshal​(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">InputStream</a> xml, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><T> type)</pre> |
| <div class="block">Reads in a Java object tree from the given XML input.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>xml</code> - The entire stream is read as an XML infoset. |
| Upon a successful completion, the stream will be closed by this method.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="unmarshal(java.io.Reader,java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unmarshal</h4> |
| <pre class="methodSignature">public static <T> T unmarshal​(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io" class="externalLink">Reader</a> xml, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><T> type)</pre> |
| <div class="block">Reads in a Java object tree from the given XML input.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>xml</code> - The character stream is read as an XML infoset. |
| The encoding declaration in the XML will be ignored. |
| Upon a successful completion, the stream will be closed by this method.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="unmarshal(javax.xml.transform.Source,java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unmarshal</h4> |
| <pre class="methodSignature">public static <T> T unmarshal​(<a href="https://docs.oracle.com/javase/8/docs/api/javax/xml/transform/Source.html?is-external=true" title="class or interface in javax.xml.transform" class="externalLink">Source</a> xml, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><T> type)</pre> |
| <div class="block">Reads in a Java object tree from the given XML input.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>xml</code> - The XML infoset that the <a href="https://docs.oracle.com/javase/8/docs/api/javax/xml/transform/Source.html?is-external=true" title="class or interface in javax.xml.transform" class="externalLink"><code>Source</code></a> represents is read.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="marshal(java.lang.Object,java.io.File)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>marshal</h4> |
| <pre class="methodSignature">public static void marshal​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> jaxbObject, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io" class="externalLink">File</a> xml)</pre> |
| <div class="block">Writes a Java object tree to XML and store it to the specified location.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>jaxbObject</code> - The Java object to be marshalled into XML. If this object is |
| a <a href="JAXBElement.html" title="class in jakarta.xml.bind"><code>JAXBElement</code></a>, it will provide the root tag name and |
| the body. If this object has <a href="annotation/XmlRootElement.html" title="annotation in jakarta.xml.bind.annotation"><code>XmlRootElement</code></a> |
| on its class definition, that will be used as the root tag name |
| and the given object will provide the body. Otherwise, |
| the root tag name is <a href="https://docs.oracle.com/javase/8/docs/api/java/beans/Introspector.html?is-external=true#decapitalize(java.lang.String)" title="class or interface in java.beans" class="externalLink"><code>infered</code></a> from |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true#getSimpleName()" title="class or interface in java.lang" class="externalLink"><code>the short class name</code></a>. |
| This parameter must not be null.</dd> |
| <dd><code>xml</code> - XML will be written to this file. If it already exists, |
| it will be overwritten.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="DataBindingException.html" title="class in jakarta.xml.bind">DataBindingException</a></code> - If the operation fails, such as due to I/O error, unbindable classes.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="marshal(java.lang.Object,java.net.URL)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>marshal</h4> |
| <pre class="methodSignature">public static void marshal​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> jaxbObject, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net" class="externalLink">URL</a> xml)</pre> |
| <div class="block">Writes a Java object tree to XML and store it to the specified location.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>jaxbObject</code> - The Java object to be marshalled into XML. If this object is |
| a <a href="JAXBElement.html" title="class in jakarta.xml.bind"><code>JAXBElement</code></a>, it will provide the root tag name and |
| the body. If this object has <a href="annotation/XmlRootElement.html" title="annotation in jakarta.xml.bind.annotation"><code>XmlRootElement</code></a> |
| on its class definition, that will be used as the root tag name |
| and the given object will provide the body. Otherwise, |
| the root tag name is <a href="https://docs.oracle.com/javase/8/docs/api/java/beans/Introspector.html?is-external=true#decapitalize(java.lang.String)" title="class or interface in java.beans" class="externalLink"><code>infered</code></a> from |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true#getSimpleName()" title="class or interface in java.lang" class="externalLink"><code>the short class name</code></a>. |
| This parameter must not be null.</dd> |
| <dd><code>xml</code> - The XML will be <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URLConnection.html?is-external=true#getOutputStream()" title="class or interface in java.net" class="externalLink"><code>sent</code></a> to the |
| resource pointed by this URL. Note that not all <code>URL</code>s support |
| such operation, and exact semantics depends on the <code>URL</code> |
| implementations. In case of <a href="https://docs.oracle.com/javase/8/docs/api/java/net/HttpURLConnection.html?is-external=true" title="class or interface in java.net" class="externalLink"><code>HTTP URLs</code></a>, |
| this will perform HTTP POST.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="DataBindingException.html" title="class in jakarta.xml.bind">DataBindingException</a></code> - If the operation fails, such as due to I/O error, unbindable classes.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="marshal(java.lang.Object,java.net.URI)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>marshal</h4> |
| <pre class="methodSignature">public static void marshal​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> jaxbObject, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink">URI</a> xml)</pre> |
| <div class="block">Writes a Java object tree to XML and store it to the specified location.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>jaxbObject</code> - The Java object to be marshalled into XML. If this object is |
| a <a href="JAXBElement.html" title="class in jakarta.xml.bind"><code>JAXBElement</code></a>, it will provide the root tag name and |
| the body. If this object has <a href="annotation/XmlRootElement.html" title="annotation in jakarta.xml.bind.annotation"><code>XmlRootElement</code></a> |
| on its class definition, that will be used as the root tag name |
| and the given object will provide the body. Otherwise, |
| the root tag name is <a href="https://docs.oracle.com/javase/8/docs/api/java/beans/Introspector.html?is-external=true#decapitalize(java.lang.String)" title="class or interface in java.beans" class="externalLink"><code>infered</code></a> from |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true#getSimpleName()" title="class or interface in java.lang" class="externalLink"><code>the short class name</code></a>. |
| This parameter must not be null.</dd> |
| <dd><code>xml</code> - The URI is <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true#toURL()" title="class or interface in java.net" class="externalLink"><code>turned into URL</code></a> and then |
| follows the handling of <code>URL</code>. See above.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="DataBindingException.html" title="class in jakarta.xml.bind">DataBindingException</a></code> - If the operation fails, such as due to I/O error, unbindable classes.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="marshal(java.lang.Object,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>marshal</h4> |
| <pre class="methodSignature">public static void marshal​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> jaxbObject, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> xml)</pre> |
| <div class="block">Writes a Java object tree to XML and store it to the specified location.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>jaxbObject</code> - The Java object to be marshalled into XML. If this object is |
| a <a href="JAXBElement.html" title="class in jakarta.xml.bind"><code>JAXBElement</code></a>, it will provide the root tag name and |
| the body. If this object has <a href="annotation/XmlRootElement.html" title="annotation in jakarta.xml.bind.annotation"><code>XmlRootElement</code></a> |
| on its class definition, that will be used as the root tag name |
| and the given object will provide the body. Otherwise, |
| the root tag name is <a href="https://docs.oracle.com/javase/8/docs/api/java/beans/Introspector.html?is-external=true#decapitalize(java.lang.String)" title="class or interface in java.beans" class="externalLink"><code>infered</code></a> from |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true#getSimpleName()" title="class or interface in java.lang" class="externalLink"><code>the short class name</code></a>. |
| This parameter must not be null.</dd> |
| <dd><code>xml</code> - The string is first interpreted as an absolute <code>URI</code>. |
| If it's not <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true#isAbsolute()" title="class or interface in java.net" class="externalLink"><code>a valid absolute URI</code></a>, |
| then it's interpreted as a <code>File</code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="DataBindingException.html" title="class in jakarta.xml.bind">DataBindingException</a></code> - If the operation fails, such as due to I/O error, unbindable classes.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="marshal(java.lang.Object,java.io.OutputStream)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>marshal</h4> |
| <pre class="methodSignature">public static void marshal​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> jaxbObject, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">OutputStream</a> xml)</pre> |
| <div class="block">Writes a Java object tree to XML and store it to the specified location.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>jaxbObject</code> - The Java object to be marshalled into XML. If this object is |
| a <a href="JAXBElement.html" title="class in jakarta.xml.bind"><code>JAXBElement</code></a>, it will provide the root tag name and |
| the body. If this object has <a href="annotation/XmlRootElement.html" title="annotation in jakarta.xml.bind.annotation"><code>XmlRootElement</code></a> |
| on its class definition, that will be used as the root tag name |
| and the given object will provide the body. Otherwise, |
| the root tag name is <a href="https://docs.oracle.com/javase/8/docs/api/java/beans/Introspector.html?is-external=true#decapitalize(java.lang.String)" title="class or interface in java.beans" class="externalLink"><code>infered</code></a> from |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true#getSimpleName()" title="class or interface in java.lang" class="externalLink"><code>the short class name</code></a>. |
| This parameter must not be null.</dd> |
| <dd><code>xml</code> - The XML will be sent to the given <a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io" class="externalLink"><code>OutputStream</code></a>. |
| Upon a successful completion, the stream will be closed by this method.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="DataBindingException.html" title="class in jakarta.xml.bind">DataBindingException</a></code> - If the operation fails, such as due to I/O error, unbindable classes.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="marshal(java.lang.Object,java.io.Writer)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>marshal</h4> |
| <pre class="methodSignature">public static void marshal​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> jaxbObject, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io" class="externalLink">Writer</a> xml)</pre> |
| <div class="block">Writes a Java object tree to XML and store it to the specified location.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>jaxbObject</code> - The Java object to be marshalled into XML. If this object is |
| a <a href="JAXBElement.html" title="class in jakarta.xml.bind"><code>JAXBElement</code></a>, it will provide the root tag name and |
| the body. If this object has <a href="annotation/XmlRootElement.html" title="annotation in jakarta.xml.bind.annotation"><code>XmlRootElement</code></a> |
| on its class definition, that will be used as the root tag name |
| and the given object will provide the body. Otherwise, |
| the root tag name is <a href="https://docs.oracle.com/javase/8/docs/api/java/beans/Introspector.html?is-external=true#decapitalize(java.lang.String)" title="class or interface in java.beans" class="externalLink"><code>infered</code></a> from |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true#getSimpleName()" title="class or interface in java.lang" class="externalLink"><code>the short class name</code></a>. |
| This parameter must not be null.</dd> |
| <dd><code>xml</code> - The XML will be sent as a character stream to the given <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io" class="externalLink"><code>Writer</code></a>. |
| Upon a successful completion, the stream will be closed by this method.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="DataBindingException.html" title="class in jakarta.xml.bind">DataBindingException</a></code> - If the operation fails, such as due to I/O error, unbindable classes.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="marshal(java.lang.Object,javax.xml.transform.Result)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>marshal</h4> |
| <pre class="methodSignature">public static void marshal​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> jaxbObject, |
| <a href="https://docs.oracle.com/javase/8/docs/api/javax/xml/transform/Result.html?is-external=true" title="class or interface in javax.xml.transform" class="externalLink">Result</a> xml)</pre> |
| <div class="block">Writes a Java object tree to XML and store it to the specified location.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>jaxbObject</code> - The Java object to be marshalled into XML. If this object is |
| a <a href="JAXBElement.html" title="class in jakarta.xml.bind"><code>JAXBElement</code></a>, it will provide the root tag name and |
| the body. If this object has <a href="annotation/XmlRootElement.html" title="annotation in jakarta.xml.bind.annotation"><code>XmlRootElement</code></a> |
| on its class definition, that will be used as the root tag name |
| and the given object will provide the body. Otherwise, |
| the root tag name is <a href="https://docs.oracle.com/javase/8/docs/api/java/beans/Introspector.html?is-external=true#decapitalize(java.lang.String)" title="class or interface in java.beans" class="externalLink"><code>infered</code></a> from |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true#getSimpleName()" title="class or interface in java.lang" class="externalLink"><code>the short class name</code></a>. |
| This parameter must not be null.</dd> |
| <dd><code>xml</code> - The XML will be sent to the <a href="https://docs.oracle.com/javase/8/docs/api/javax/xml/transform/Result.html?is-external=true" title="class or interface in javax.xml.transform" class="externalLink"><code>Result</code></a> object.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="DataBindingException.html" title="class in jakarta.xml.bind">DataBindingException</a></code> - If the operation fails, such as due to I/O error, unbindable classes.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <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><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">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> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </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> |
