jakartaee-9.1/javadoc/jakarta/xml/bind/annotation/XmlEnumValue.html - tomee-site-pub - Git at Google

 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
 <!-- NewPage -->
 <html lang="en">
 <head>
 <title>XmlEnumValue</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="XmlEnumValue";
         }
     }
     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/XmlEnum.html" title="annotation in jakarta.xml.bind.annotation"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../../../jakarta/xml/bind/annotation/XmlID.html" title="annotation in jakarta.xml.bind.annotation"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../index.html?jakarta/xml/bind/annotation/XmlEnumValue.html" target="_top">Frames</a></li>
 <li><a href="XmlEnumValue.html" target="_top">No&nbsp;Frames</a></li>
 </ul>
 <ul class="navList" id="allclasses_navbar_top">
 <li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#annotation.type.required.element.summary">Required</a>&nbsp;|&nbsp;</li>
 <li>Optional</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 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 XmlEnumValue" class="title">Annotation Type XmlEnumValue</h2>
 </div>
 <div class="contentContainer">
 <div class="description">
 <ul class="blockList">
 <li class="blockList">
 <hr>
 <br>
 <pre>@Retention(value=RUNTIME)
  @Target(value=FIELD)
 public @interface <span class="memberNameLabel">XmlEnumValue</span></pre>
 <div class="block">Maps an enum constant in <code>Enum</code> type to XML representation.

  <p> <b>Usage</b> </p>

  <p> The <code>@XmlEnumValue</code> annotation can be used with the
      following program elements:
  <ul>
    <li>enum constant</li>
  </ul>

  <p>See "Package Specification" in jakarta.xml.bind.package javadoc for
  additional common information.</p>

  <p>This annotation, together with <a href="../../../../jakarta/xml/bind/annotation/XmlEnum.html" title="annotation in jakarta.xml.bind.annotation"><code>XmlEnum</code></a> provides a
  mapping of enum type to XML representation.

  <p>An enum type is mapped to a schema simple type with enumeration
  facets. The schema type is derived from the Java type specified in
  <code>@XmlEnum.value()</code>. Each enum constant <code>@XmlEnumValue</code>
  must have a valid lexical representation for the type
  <code>@XmlEnum.value()</code>

  <p> In the absence of this annotation, <code>Enum.name()</code> is used
  as the XML representation.

  <p> <b>Example 1: </b>Map enum constant name -&gt; enumeration facet</p>
  <pre>
      //Example: Code fragment
      &#64;XmlEnum(String.class)
      public enum Card { CLUBS, DIAMONDS, HEARTS, SPADES }
  <code>

      &lt;!-- Example: XML Schema fragment --&gt;
      &lt;xs:simpleType name="Card"&gt;
        &lt;xs:restriction base="xs:string"/&gt;
          &lt;xs:enumeration value="CLUBS"/&gt;
          &lt;xs:enumeration value="DIAMONDS"/&gt;
          &lt;xs:enumeration value="HEARTS"/&gt;
          &lt;xs:enumeration value="SPADES"/&gt;
      &lt;/xs:simpleType&gt;
  </code></pre>

  <p><b>Example 2: </b>Map enum constant name(value) -&gt; enumeration facet </p>
  <pre>
      //Example: code fragment
      &#64;XmlType
      &#64;XmlEnum(Integer.class)
      public enum Coin {
          &#64;XmlEnumValue("1") PENNY(1),
          &#64;XmlEnumValue("5") NICKEL(5),
          &#64;XmlEnumValue("10") DIME(10),
          &#64;XmlEnumValue("25") QUARTER(25) }
  <code>

      &lt;!-- Example: XML Schema fragment --&gt;
      &lt;xs:simpleType name="Coin"&gt;
        &lt;xs:restriction base="xs:int"&gt;
          &lt;xs:enumeration value="1"/&gt;
          &lt;xs:enumeration value="5"/&gt;
          &lt;xs:enumeration value="10"/&gt;
          &lt;xs:enumeration value="25"/&gt;
        &lt;/xs:restriction&gt;
      &lt;/xs:simpleType&gt;
  </code></pre>

  <p><b>Example 3: </b>Map enum constant name -&gt; enumeration facet </p>

  <pre>
      //Code fragment
      &#64;XmlType
      &#64;XmlEnum(Integer.class)
      public enum Code {
          &#64;XmlEnumValue("1") ONE,
          &#64;XmlEnumValue("2") TWO;
      }
  <code>

      &lt;!-- Example: XML Schema fragment --&gt;
      &lt;xs:simpleType name="Code"&gt;
        &lt;xs:restriction base="xs:int"&gt;
          &lt;xs:enumeration value="1"/&gt;
          &lt;xs:enumeration value="2"/&gt;
        &lt;/xs:restriction&gt;
      &lt;/xs:simpleType&gt;
  </code></pre></div>
 <dl>
 <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 =========== -->
 <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">&nbsp;</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/XmlEnumValue.html#value--">value</a></span></code>&nbsp;</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="value--">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>value</h4>
 <pre>public abstract&nbsp;java.lang.String&nbsp;value</pre>
 </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/XmlEnum.html" title="annotation in jakarta.xml.bind.annotation"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../../../jakarta/xml/bind/annotation/XmlID.html" title="annotation in jakarta.xml.bind.annotation"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../index.html?jakarta/xml/bind/annotation/XmlEnumValue.html" target="_top">Frames</a></li>
 <li><a href="XmlEnumValue.html" target="_top">No&nbsp;Frames</a></li>
 </ul>
 <ul class="navList" id="allclasses_navbar_bottom">
 <li><a href="../../../../allclasses-noframe.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>
 </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>Optional</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 name="skip.navbar.bottom">
 <!--   -->
 </a></div>
 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 </body>
 </html>
	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
	<!-- NewPage -->
	<html lang="en">
	<head>
	<title>XmlEnumValue</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="XmlEnumValue";
	}
	}
	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/XmlEnum.html" title="annotation in jakarta.xml.bind.annotation"><span class="typeNameLink">Prev Class</span></a></li>
	<li><a href="../../../../jakarta/xml/bind/annotation/XmlID.html" title="annotation 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/XmlEnumValue.html" target="_top">Frames</a></li>
	<li><a href="XmlEnumValue.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>Optional</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 XmlEnumValue" class="title">Annotation Type XmlEnumValue</h2>
	</div>
	<div class="contentContainer">
	<div class="description">
	<ul class="blockList">
	<li class="blockList">
	<hr>
	<br>
	<pre>@Retention(value=RUNTIME)
	@Target(value=FIELD)
	public @interface <span class="memberNameLabel">XmlEnumValue</span></pre>
	<div class="block">Maps an enum constant in <code>Enum</code> type to XML representation.

	<p> <b>Usage</b> </p>

	<p> The <code>@XmlEnumValue</code> annotation can be used with the
	following program elements:
	<ul>
	<li>enum constant</li>
	</ul>

	<p>See "Package Specification" in jakarta.xml.bind.package javadoc for
	additional common information.</p>

	<p>This annotation, together with <a href="../../../../jakarta/xml/bind/annotation/XmlEnum.html" title="annotation in jakarta.xml.bind.annotation"><code>XmlEnum</code></a> provides a
	mapping of enum type to XML representation.

	<p>An enum type is mapped to a schema simple type with enumeration
	facets. The schema type is derived from the Java type specified in
	<code>@XmlEnum.value()</code>. Each enum constant <code>@XmlEnumValue</code>
	must have a valid lexical representation for the type
	<code>@XmlEnum.value()</code>

	<p> In the absence of this annotation, <code>Enum.name()</code> is used
	as the XML representation.

	<p> <b>Example 1: </b>Map enum constant name -> enumeration facet</p>
	<pre>
	//Example: Code fragment
	@XmlEnum(String.class)
	public enum Card { CLUBS, DIAMONDS, HEARTS, SPADES }
	<code>

	<!-- Example: XML Schema fragment -->
	<xs:simpleType name="Card">
	<xs:restriction base="xs:string"/>
	<xs:enumeration value="CLUBS"/>
	<xs:enumeration value="DIAMONDS"/>
	<xs:enumeration value="HEARTS"/>
	<xs:enumeration value="SPADES"/>
	</xs:simpleType>
	</code></pre>

	<p><b>Example 2: </b>Map enum constant name(value) -> enumeration facet </p>
	<pre>
	//Example: code fragment
	@XmlType
	@XmlEnum(Integer.class)
	public enum Coin {
	@XmlEnumValue("1") PENNY(1),
	@XmlEnumValue("5") NICKEL(5),
	@XmlEnumValue("10") DIME(10),
	@XmlEnumValue("25") QUARTER(25) }
	<code>

	<!-- Example: XML Schema fragment -->
	<xs:simpleType name="Coin">
	<xs:restriction base="xs:int">
	<xs:enumeration value="1"/>
	<xs:enumeration value="5"/>
	<xs:enumeration value="10"/>
	<xs:enumeration value="25"/>
	</xs:restriction>
	</xs:simpleType>
	</code></pre>

	<p><b>Example 3: </b>Map enum constant name -> enumeration facet </p>

	<pre>
	//Code fragment
	@XmlType
	@XmlEnum(Integer.class)
	public enum Code {
	@XmlEnumValue("1") ONE,
	@XmlEnumValue("2") TWO;
	}
	<code>

	<!-- Example: XML Schema fragment -->
	<xs:simpleType name="Code">
	<xs:restriction base="xs:int">
	<xs:enumeration value="1"/>
	<xs:enumeration value="2"/>
	</xs:restriction>
	</xs:simpleType>
	</code></pre></div>
	<dl>
	<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 =========== -->
	<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/XmlEnumValue.html#value--">value</a></span></code> </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="value--">
	<!-- -->
	</a>
	<ul class="blockListLast">
	<li class="blockList">
	<h4>value</h4>
	<pre>public abstract java.lang.String value</pre>
	</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/XmlEnum.html" title="annotation in jakarta.xml.bind.annotation"><span class="typeNameLink">Prev Class</span></a></li>
	<li><a href="../../../../jakarta/xml/bind/annotation/XmlID.html" title="annotation 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/XmlEnumValue.html" target="_top">Frames</a></li>
	<li><a href="XmlEnumValue.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>Optional</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>