| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.2) on Wed Apr 22 10:19:16 CDT 2020 --> |
| <title>XmlRootElement (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="XmlRootElement (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><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>Field | </li> |
| <li>Required | </li> |
| <li><a href="#annotation.type.optional.element.summary">Optional</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#annotation.type.element.detail">Element</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.annotation</a></div> |
| <h2 title="Annotation Type XmlRootElement" class="title">Annotation Type XmlRootElement</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation" class="externalLink">@Retention</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation" class="externalLink">RUNTIME</a>) |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation" class="externalLink">@Target</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#TYPE" title="class or interface in java.lang.annotation" class="externalLink">TYPE</a>) |
| public @interface <span class="memberNameLabel">XmlRootElement</span></pre> |
| <div class="block">Maps a class or an enum type to an XML element. |
| |
| <p> <b>Usage</b> </p> |
| <p> |
| The @XmlRootElement annotation can be used with the following program |
| elements: |
| <ul> |
| <li> a top level class </li> |
| <li> an enum type </li> |
| </ul> |
| |
| <p>See "Package Specification" in jakarta.xml.bind.package javadoc for |
| additional common information.</p> |
| |
| <p> |
| When a top level class or an enum type is annotated with the |
| @XmlRootElement annotation, then its value is represented |
| as XML element in an XML document. |
| |
| <p> This annotation can be used with the following annotations: |
| <a href="XmlType.html" title="annotation in jakarta.xml.bind.annotation"><code>XmlType</code></a>, <a href="XmlEnum.html" title="annotation in jakarta.xml.bind.annotation"><code>XmlEnum</code></a>, <a href="XmlAccessorType.html" title="annotation in jakarta.xml.bind.annotation"><code>XmlAccessorType</code></a>, |
| <a href="XmlAccessorOrder.html" title="annotation in jakarta.xml.bind.annotation"><code>XmlAccessorOrder</code></a>. |
| </p> |
| |
| <p> |
| <b>Example 1: </b> Associate an element with XML Schema type |
| <pre> |
| // Example: Code fragment |
| @XmlRootElement |
| class Point { |
| int x; |
| int y; |
| Point(int _x,int _y) {x=_x;y=_y;} |
| } |
| </pre> |
| |
| <pre> |
| //Example: Code fragment corresponding to XML output |
| marshal( new Point(3,5), System.out); |
| </pre> |
| |
| <pre><code> |
| |
| <!-- Example: XML output --> |
| <point> |
| <x> 3 </x> |
| <y> 5 </y> |
| </point> |
| </code></pre> |
| |
| The annotation causes an global element declaration to be produced |
| in the schema. The global element declaration is associated with |
| the XML schema type to which the class is mapped. |
| |
| <pre><code> |
| |
| <!-- Example: XML schema definition --> |
| <xs:element name="point" type="point"/> |
| <xs:complexType name="point"> |
| <xs:sequence> |
| <xs:element name="x" type="xs:int"/> |
| <xs:element name="y" type="xs:int"/> |
| </xs:sequence> |
| </xs:complexType> |
| </code></pre> |
| |
| <p> |
| |
| <b>Example 2: Orthogonality to type inheritance </b> |
| |
| <p> |
| An element declaration annotated on a type is not inherited by its |
| derived types. The following example shows this. |
| <pre> |
| // Example: Code fragment |
| @XmlRootElement |
| class Point3D extends Point { |
| int z; |
| Point3D(int _x,int _y,int _z) {super(_x,_y);z=_z;} |
| } |
| |
| //Example: Code fragment corresponding to XML output * |
| marshal( new Point3D(3,5,0), System.out ); |
| <code> |
| |
| <!-- Example: XML output --> |
| <!-- The element name is point3D not point --> |
| <point3D> |
| <x>3</x> |
| <y>5</y> |
| <z>0</z> |
| </point3D> |
| |
| <!-- Example: XML schema definition --> |
| <xs:element name="point3D" type="point3D"/> |
| <xs:complexType name="point3D"> |
| <xs:complexContent> |
| <xs:extension base="point"> |
| <xs:sequence> |
| <xs:element name="z" type="xs:int"/> |
| </xs:sequence> |
| </xs:extension> |
| </xs:complexContent> |
| </xs:complexType> |
| </code></pre> |
| |
| <b>Example 3: </b> Associate a global element with XML Schema type |
| to which the class is mapped. |
| <pre> |
| //Example: Code fragment |
| @XmlRootElement(name="PriceElement") |
| public class USPrice { |
| @XmlElement |
| public java.math.BigDecimal price; |
| } |
| <code> |
| |
| <!-- Example: XML schema definition --> |
| <xs:element name="PriceElement" type="USPrice"/> |
| <xs:complexType name="USPrice"> |
| <xs:sequence> |
| <xs:element name="price" type="xs:decimal"/> |
| </sequence> |
| </xs:complexType> |
| </code></pre></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd>Sekhar Vajjhala, Sun Microsystems, Inc.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6, JAXB 2.0</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="annotation.type.optional.element.summary"> |
| <!-- --> |
| </a> |
| <h3>Optional Element Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Optional Elements</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Optional Element</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><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></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#name()">name</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">local name of the XML element.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><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></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#namespace()">namespace</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">namespace name of the XML element.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="annotation.type.element.detail"> |
| <!-- --> |
| </a> |
| <h3>Element Detail</h3> |
| <a id="namespace()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>namespace</h4> |
| <pre><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> namespace</pre> |
| <div class="block">namespace name of the XML element. |
| <p> |
| If the value is "##default", then the XML namespace name is derived |
| from the package of the class ( <a href="XmlSchema.html" title="annotation in jakarta.xml.bind.annotation"><code>XmlSchema</code></a> ). If the |
| package is unnamed, then the XML namespace is the default empty |
| namespace.</div> |
| <dl> |
| <dt>Default:</dt> |
| <dd>"##default"</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="name()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>name</h4> |
| <pre><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> name</pre> |
| <div class="block">local name of the XML element. |
| <p> |
| If the value is "##default", then the name is derived from the |
| class name.</div> |
| <dl> |
| <dt>Default:</dt> |
| <dd>"##default"</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>Field | </li> |
| <li>Required | </li> |
| <li><a href="#annotation.type.optional.element.summary">Optional</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#annotation.type.element.detail">Element</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> |
