api/3.0/jakarta/xml/bind/annotation/XmlElementDecl.html - gerrit/www.eclipse.org/eclipselink - Git at Google

 <!DOCTYPE HTML>
 <!-- NewPage -->
 <html lang="en">
 <head>
 <!-- Generated by javadoc (11.0.2) on Wed Apr 22 10:19:16 CDT 2020 -->
 <title>XmlElementDecl (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="XmlElementDecl (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&nbsp;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:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#annotation.type.required.element.summary">Required</a>&nbsp;|&nbsp;</li>
 <li><a href="#annotation.type.optional.element.summary">Optional</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</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">&nbsp;</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>&nbsp;<a href="package-summary.html">jakarta.xml.bind.annotation</a></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>
 <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#METHOD" title="class or interface in java.lang.annotation" class="externalLink">METHOD</a>)
 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 &#64;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 &#64;XmlElementDecl must be marked with <a href="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 <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"><code>Object</code></a>.</li>
  </ul>

  <p><b>Example 1: </b>Annotation on a factory method
  <pre>
      // Example: code fragment
      &#64;XmlRegistry
      class ObjectFactory {
          &#64;XmlElementDecl(name="foo")
          JAXBElement&lt;String&gt; createFoo(String s) { ... }
      }
  </pre>
  <pre> <code>

      &lt;!-- XML input --&gt;
      &lt;foo&gt;string&lt;/foo&gt;

      // Example: code fragment corresponding to XML input
      JAXBElement&lt;String&gt; o =
      (JAXBElement&lt;String&gt;)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"

      &lt;!-- Example: XML schema definition --&gt;
      &lt;xs:element name="foo" type="xs:string"/&gt;
  </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>
      &lt;!-- Example: XML schema definition --&gt;
      &lt;xs:schema&gt;
        &lt;xs:complexType name="pea"&gt;
          &lt;xs:choice maxOccurs="unbounded"&gt;
            &lt;xs:element name="foo" type="xs:string"/&gt;
            &lt;xs:element name="bar" type="xs:string"/&gt;
          &lt;/xs:choice&gt;
        &lt;/xs:complexType&gt;
        &lt;xs:element name="foo" type="xs:int"/&gt;
      &lt;/xs:schema&gt;
  </code></pre>
  <pre>
      // Example: expected default binding
      class Pea {
          &#64;XmlElementRefs({
              &#64;XmlElementRef(name="foo",type=JAXBElement.class)
              &#64;XmlElementRef(name="bar",type=JAXBElement.class)
          })
          List&lt;JAXBElement&lt;String&gt;&gt; fooOrBar;
      }

      &#64;XmlRegistry
      class ObjectFactory {
          &#64;XmlElementDecl(scope=Pea.class,name="foo")
          JAXBElement&lt;String&gt; createPeaFoo(String s);

          &#64;XmlElementDecl(scope=Pea.class,name="bar")
          JAXBElement&lt;String&gt; createPeaBar(String s);

          &#64;XmlElementDecl(name="foo")
          JAXBElement&lt;Integer&gt; 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="seeLabel">See Also:</span></dt>
 <dd><a href="XmlRegistry.html" title="annotation in jakarta.xml.bind.annotation"><code>XmlRegistry</code></a></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 REQUIRED MEMBER SUMMARY =========== -->
 <section role="region">
 <ul class="blockList">
 <li class="blockList"><a id="annotation.type.required.element.summary">
 <!--   -->
 </a>
 <h3>Required Element Summary</h3>
 <table class="memberSummary">
 <caption><span>Required Elements</span><span class="tabEnd">&nbsp;</span></caption>
 <tr>
 <th class="colFirst" scope="col">Modifier and Type</th>
 <th class="colSecond" scope="col">Required 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>
 </table>
 </li>
 </ul>
 </section>
 <!-- =========== 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">&nbsp;</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="#defaultValue()">defaultValue</a></span></code></th>
 <td class="colLast">
 <div class="block">Default value of this 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>
 <tr class="altColor">
 <td class="colFirst"><code><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></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#scope()">scope</a></span></code></th>
 <td class="colLast">
 <div class="block">scope of the mapping.</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="#substitutionHeadName()">substitutionHeadName</a></span></code></th>
 <td class="colLast">
 <div class="block">XML local name of a substitution group's head element.</div>
 </td>
 </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="#substitutionHeadNamespace()">substitutionHeadNamespace</a></span></code></th>
 <td class="colLast">
 <div class="block">namespace name of a substitution group's head 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="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>&nbsp;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="#namespace()"><code>namespace()</code></a></dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 </section>
 <!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
 <section role="region">
 <ul class="blockList">
 <li class="blockList"><a id="scope()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>scope</h4>
 <pre><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>&nbsp;scope</pre>
 <div class="block">scope of the mapping.

  <p>
  If this is not <a href="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>
 </section>
 <section role="region">
 <ul class="blockList">
 <li class="blockList"><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>&nbsp;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="#name()"><code>name()</code></a></dd>
 </dl>
 <dl>
 <dt>Default:</dt>
 <dd>"##default"</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 </section>
 <section role="region">
 <ul class="blockList">
 <li class="blockList"><a id="substitutionHeadNamespace()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>substitutionHeadNamespace</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>&nbsp;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="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="#substitutionHeadName()"><code>substitutionHeadName()</code></a></dd>
 </dl>
 <dl>
 <dt>Default:</dt>
 <dd>"##default"</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 </section>
 <section role="region">
 <ul class="blockList">
 <li class="blockList"><a id="substitutionHeadName()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>substitutionHeadName</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>&nbsp;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="#substitutionHeadNamespace()"><code>substitutionHeadNamespace()</code></a></dd>
 </dl>
 <dl>
 <dt>Default:</dt>
 <dd>""</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 </section>
 <section role="region">
 <ul class="blockList">
 <li class="blockList"><a id="defaultValue()">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>defaultValue</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>&nbsp;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>
 </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&nbsp;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:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#annotation.type.required.element.summary">Required</a>&nbsp;|&nbsp;</li>
 <li><a href="#annotation.type.optional.element.summary">Optional</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</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 &#169; 2017&#x2013;2020 <a href="http://www.eclipse.org/eclipselink">Eclipse.org - EclipseLink Project</a>. All rights reserved.</small></p>
 </footer>
 </body>
 </html>
	<!DOCTYPE HTML>
	<!-- NewPage -->
	<html lang="en">
	<head>
	<!-- Generated by javadoc (11.0.2) on Wed Apr 22 10:19:16 CDT 2020 -->
	<title>XmlElementDecl (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="XmlElementDecl (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><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 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 XmlElementDecl" class="title">Annotation Type XmlElementDecl</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#METHOD" title="class or interface in java.lang.annotation" class="externalLink">METHOD</a>)
	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="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 <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"><code>Object</code></a>.</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="seeLabel">See Also:</span></dt>
	<dd><a href="XmlRegistry.html" title="annotation in jakarta.xml.bind.annotation"><code>XmlRegistry</code></a></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 REQUIRED MEMBER SUMMARY =========== -->
	<section role="region">
	<ul class="blockList">
	<li class="blockList"><a id="annotation.type.required.element.summary">
	<!-- -->
	</a>
	<h3>Required Element Summary</h3>
	<table class="memberSummary">
	<caption><span>Required Elements</span><span class="tabEnd"> </span></caption>
	<tr>
	<th class="colFirst" scope="col">Modifier and Type</th>
	<th class="colSecond" scope="col">Required 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>
	</table>
	</li>
	</ul>
	</section>
	<!-- =========== 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="#defaultValue()">defaultValue</a></span></code></th>
	<td class="colLast">
	<div class="block">Default value of this 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>
	<tr class="altColor">
	<td class="colFirst"><code><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></code></td>
	<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#scope()">scope</a></span></code></th>
	<td class="colLast">
	<div class="block">scope of the mapping.</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="#substitutionHeadName()">substitutionHeadName</a></span></code></th>
	<td class="colLast">
	<div class="block">XML local name of a substitution group's head element.</div>
	</td>
	</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="#substitutionHeadNamespace()">substitutionHeadNamespace</a></span></code></th>
	<td class="colLast">
	<div class="block">namespace name of a substitution group's head 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="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>
	<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="#namespace()"><code>namespace()</code></a></dd>
	</dl>
	</li>
	</ul>
	</li>
	</ul>
	</section>
	<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
	<section role="region">
	<ul class="blockList">
	<li class="blockList"><a id="scope()">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>scope</h4>
	<pre><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> scope</pre>
	<div class="block">scope of the mapping.

	<p>
	If this is not <a href="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>
	</section>
	<section role="region">
	<ul class="blockList">
	<li class="blockList"><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 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="#name()"><code>name()</code></a></dd>
	</dl>
	<dl>
	<dt>Default:</dt>
	<dd>"##default"</dd>
	</dl>
	</li>
	</ul>
	</li>
	</ul>
	</section>
	<section role="region">
	<ul class="blockList">
	<li class="blockList"><a id="substitutionHeadNamespace()">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>substitutionHeadNamespace</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> 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="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="#substitutionHeadName()"><code>substitutionHeadName()</code></a></dd>
	</dl>
	<dl>
	<dt>Default:</dt>
	<dd>"##default"</dd>
	</dl>
	</li>
	</ul>
	</li>
	</ul>
	</section>
	<section role="region">
	<ul class="blockList">
	<li class="blockList"><a id="substitutionHeadName()">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>substitutionHeadName</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> 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="#substitutionHeadNamespace()"><code>substitutionHeadNamespace()</code></a></dd>
	</dl>
	<dl>
	<dt>Default:</dt>
	<dd>""</dd>
	</dl>
	</li>
	</ul>
	</li>
	</ul>
	</section>
	<section role="region">
	<ul class="blockList">
	<li class="blockList"><a id="defaultValue()">
	<!-- -->
	</a>
	<ul class="blockListLast">
	<li class="blockList">
	<h4>defaultValue</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> 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>
	</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><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 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>