| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>XmlElementDecl</title> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| |
| <link rel="shortcut icon" href="/img/jakarta-favicon.ico"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="XmlElementDecl"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <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> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../jakarta/xml/bind/annotation/XmlElement.DEFAULT.html" title="class in jakarta.xml.bind.annotation"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../jakarta/xml/bind/annotation/XmlElementDecl.GLOBAL.html" title="class in jakarta.xml.bind.annotation"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?jakarta/xml/bind/annotation/XmlElementDecl.html" target="_top">Frames</a></li> |
| <li><a href="XmlElementDecl.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>Field | </li> |
| <li><a href="#annotation.type.required.element.summary">Required</a> | </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 name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">jakarta.xml.bind.annotation</div> |
| <h2 title="Annotation Type XmlElementDecl" class="title">Annotation Type XmlElementDecl</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>@Retention(value=RUNTIME) |
| @Target(value=METHOD) |
| public @interface <span class="memberNameLabel">XmlElementDecl</span></pre> |
| <div class="block">Maps a factory method to a XML element. |
| |
| <p> <b>Usage</b> </p> |
| |
| The annotation creates a mapping between an XML schema element |
| declaration and a <i> element factory method </i> that returns a |
| JAXBElement instance representing the element |
| declaration. Typically, the element factory method is generated |
| (and annotated) from a schema into the ObjectFactory class in a |
| Java package that represents the binding of the element |
| declaration's target namespace. Thus, while the annotation syntax |
| allows @XmlElementDecl to be used on any method, semantically |
| its use is restricted to annotation of element factory method. |
| |
| The usage is subject to the following constraints: |
| |
| <ul> |
| <li> The class containing the element factory method annotated |
| with @XmlElementDecl must be marked with <a href="../../../../jakarta/xml/bind/annotation/XmlRegistry.html" title="annotation in jakarta.xml.bind.annotation"><code>XmlRegistry</code></a>. </li> |
| <li> The element factory method must take one parameter |
| assignable to <code>Object</code>.</li> |
| </ul> |
| |
| <p><b>Example 1: </b>Annotation on a factory method |
| <pre> |
| // Example: code fragment |
| @XmlRegistry |
| class ObjectFactory { |
| @XmlElementDecl(name="foo") |
| JAXBElement<String> createFoo(String s) { ... } |
| } |
| </pre> |
| <pre> <code> |
| |
| <!-- XML input --> |
| <foo>string</foo> |
| |
| // Example: code fragment corresponding to XML input |
| JAXBElement<String> o = |
| (JAXBElement<String>)unmarshaller.unmarshal(aboveDocument); |
| // print JAXBElement instance to show values |
| System.out.println(o.getName()); // prints "{}foo" |
| System.out.println(o.getValue()); // prints "string" |
| System.out.println(o.getValue().getClass()); // prints "java.lang.String" |
| |
| <!-- Example: XML schema definition --> |
| <xs:element name="foo" type="xs:string"/> |
| </code></pre> |
| |
| <p><b>Example 2: </b> Element declaration with non local scope |
| <p> |
| The following example illustrates the use of scope annotation |
| parameter in binding of element declaration in schema derived |
| code. |
| <p> |
| The following example may be replaced in a future revision of |
| this javadoc. |
| |
| <pre><code> |
| <!-- Example: XML schema definition --> |
| <xs:schema> |
| <xs:complexType name="pea"> |
| <xs:choice maxOccurs="unbounded"> |
| <xs:element name="foo" type="xs:string"/> |
| <xs:element name="bar" type="xs:string"/> |
| </xs:choice> |
| </xs:complexType> |
| <xs:element name="foo" type="xs:int"/> |
| </xs:schema> |
| </code></pre> |
| <pre> |
| // Example: expected default binding |
| class Pea { |
| @XmlElementRefs({ |
| @XmlElementRef(name="foo",type=JAXBElement.class) |
| @XmlElementRef(name="bar",type=JAXBElement.class) |
| }) |
| List<JAXBElement<String>> fooOrBar; |
| } |
| |
| @XmlRegistry |
| class ObjectFactory { |
| @XmlElementDecl(scope=Pea.class,name="foo") |
| JAXBElement<String> createPeaFoo(String s); |
| |
| @XmlElementDecl(scope=Pea.class,name="bar") |
| JAXBElement<String> createPeaBar(String s); |
| |
| @XmlElementDecl(name="foo") |
| JAXBElement<Integer> createFoo(Integer i); |
| } |
| |
| </pre> |
| Without scope createFoo and createPeaFoo would become ambiguous |
| since both of them map to a XML schema element with the same local |
| name "foo".</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6, JAXB 2.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../jakarta/xml/bind/annotation/XmlRegistry.html" title="annotation in jakarta.xml.bind.annotation"><code>XmlRegistry</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="annotation.type.required.element.summary"> |
| <!-- --> |
| </a> |
| <h3>Required Element Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Required Element Summary table, listing required elements, and an explanation"> |
| <caption><span>Required Elements</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Required Element and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/xml/bind/annotation/XmlElementDecl.html#name--">name</a></span></code> |
| <div class="block">local name of the XML element.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="annotation.type.optional.element.summary"> |
| <!-- --> |
| </a> |
| <h3>Optional Element Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation"> |
| <caption><span>Optional Elements</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Optional Element and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/xml/bind/annotation/XmlElementDecl.html#defaultValue--">defaultValue</a></span></code> |
| <div class="block">Default value of this element.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/xml/bind/annotation/XmlElementDecl.html#namespace--">namespace</a></span></code> |
| <div class="block">namespace name of the XML element.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>java.lang.Class</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/xml/bind/annotation/XmlElementDecl.html#scope--">scope</a></span></code> |
| <div class="block">scope of the mapping.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/xml/bind/annotation/XmlElementDecl.html#substitutionHeadName--">substitutionHeadName</a></span></code> |
| <div class="block">XML local name of a substitution group's head element.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/xml/bind/annotation/XmlElementDecl.html#substitutionHeadNamespace--">substitutionHeadNamespace</a></span></code> |
| <div class="block">namespace name of a substitution group's head XML element.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="annotation.type.element.detail"> |
| <!-- --> |
| </a> |
| <h3>Element Detail</h3> |
| <a name="name--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>name</h4> |
| <pre>public abstract java.lang.String name</pre> |
| <div class="block">local name of the XML element. |
| |
| <p> |
| <b> Note to reviewers: </b> There is no default name; since |
| the annotation is on a factory method, it is not clear that the |
| method name can be derived from the factory method name.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../jakarta/xml/bind/annotation/XmlElementDecl.html#namespace--"><code>namespace()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="scope--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>scope</h4> |
| <pre>public abstract java.lang.Class scope</pre> |
| <div class="block">scope of the mapping. |
| |
| <p> |
| If this is not <a href="../../../../jakarta/xml/bind/annotation/XmlElementDecl.GLOBAL.html" title="class in jakarta.xml.bind.annotation"><code>XmlElementDecl.GLOBAL</code></a>, then this element |
| declaration mapping is only active within the specified class.</div> |
| <dl> |
| <dt>Default:</dt> |
| <dd>jakarta.xml.bind.annotation.XmlElementDecl.GLOBAL.class</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="namespace--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>namespace</h4> |
| <pre>public abstract java.lang.String namespace</pre> |
| <div class="block">namespace name of the XML element. |
| <p> |
| If the value is "##default", then the value is the namespace |
| name for the package of the class containing this factory method.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../jakarta/xml/bind/annotation/XmlElementDecl.html#name--"><code>name()</code></a></dd> |
| </dl> |
| <dl> |
| <dt>Default:</dt> |
| <dd>"##default"</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="substitutionHeadNamespace--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>substitutionHeadNamespace</h4> |
| <pre>public abstract java.lang.String substitutionHeadNamespace</pre> |
| <div class="block">namespace name of a substitution group's head XML element. |
| <p> |
| This specifies the namespace name of the XML element whose local |
| name is specified by <code>substitutionHeadName()</code>. |
| <p> |
| If <code>susbtitutionHeadName()</code> is "", then this |
| value can only be "##default". But the value is ignored since |
| since this element is not part of susbtitution group when the |
| value of <code>susbstitutionHeadName()</code> is "". |
| <p> |
| If <code>susbtitutionHeadName()</code> is not "" and the value is |
| "##default", then the namespace name is the namespace name to |
| which the package of the containing class, marked with <a href="../../../../jakarta/xml/bind/annotation/XmlRegistry.html" title="annotation in jakarta.xml.bind.annotation"><code>XmlRegistry</code></a>, is mapped. |
| <p> |
| If <code>susbtitutionHeadName()</code> is not "" and the value is |
| not "##default", then the value is the namespace name.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../jakarta/xml/bind/annotation/XmlElementDecl.html#substitutionHeadName--"><code>substitutionHeadName()</code></a></dd> |
| </dl> |
| <dl> |
| <dt>Default:</dt> |
| <dd>"##default"</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="substitutionHeadName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>substitutionHeadName</h4> |
| <pre>public abstract java.lang.String substitutionHeadName</pre> |
| <div class="block">XML local name of a substitution group's head element. |
| <p> |
| If the value is "", then this element is not part of any |
| substitution group.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../jakarta/xml/bind/annotation/XmlElementDecl.html#substitutionHeadNamespace--"><code>substitutionHeadNamespace()</code></a></dd> |
| </dl> |
| <dl> |
| <dt>Default:</dt> |
| <dd>""</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="defaultValue--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>defaultValue</h4> |
| <pre>public abstract java.lang.String defaultValue</pre> |
| <div class="block">Default value of this element. |
| |
| <p> |
| The <pre>''</pre> value specified as a default of this annotation element |
| is used as a poor-man's substitute for null to allow implementations |
| to recognize the 'no default value' state.</div> |
| <dl> |
| <dt>Default:</dt> |
| <dd>"\u0000"</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> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <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> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../jakarta/xml/bind/annotation/XmlElement.DEFAULT.html" title="class in jakarta.xml.bind.annotation"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../jakarta/xml/bind/annotation/XmlElementDecl.GLOBAL.html" title="class in jakarta.xml.bind.annotation"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?jakarta/xml/bind/annotation/XmlElementDecl.html" target="_top">Frames</a></li> |
| <li><a href="XmlElementDecl.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>Field | </li> |
| <li><a href="#annotation.type.required.element.summary">Required</a> | </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 name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |