blob: 7d9ab8c3825bedd26d7868cd9887e39c8555f2c4 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta http-equiv="Content-Script-Type" content="text/javascript" />
<title>Mapping Enums | EclipseLink 2.7 EclipseLink MOXy</title>
<meta name="generator" content="Oracle DARB XHTML Converter (Mode = document) - Version 1.0.22 Build 1" />
<meta name="date" content="2014-06-10T10:25:32Z" />
<meta name="robots" content="noarchive" />
<meta name="doctitle" content="Mapping Enums" />
<meta name="relnum" content="Release 2.7" />
<meta name="partnum" content="" />
<link rel="stylesheet" type="text/css" href="../../dcommon/style.css" media="screen" />
<link rel="copyright" href="../../dcommon/html/cpyr.htm" title="Copyright" type="text/html" />
<link rel="start" href="../../index.htm" title="Home" type="text/html" />
<link rel="contents" href="toc.htm" title="Contents" type="text/html" />
<link rel="prev" href="simple_values003.htm" title="Previous" type="text/html" />
<link rel="next" href="special_schema_types.htm" title="Next" type="text/html" />
<!-- START: Disqus --><script type="text/javascript"> var disqus_developer = 0; </script><!-- END: Disqus --><!-- START: Sharethis --><script type="text/javascript">var switchTo5x=true;</script><script type="text/javascript" src="http://w.sharethis.com/button/buttons.js"></script><script type="text/javascript" src="http://s.sharethis.com/loader.js"></script> <!-- END: Sharethis --></head>
<body bgcolor="#FFFFFF"><iframe id="docheader" frameborder="0" framemargin="0" scrolling="no" src="../../dcommon/header.html"></iframe><script src="http://www.google.com/jsapi" type="text/javascript"></script><script type="text/javascript"> google.load('search', '1', {language : 'en'}); google.setOnLoadCallback(function() { var customSearchOptions = {}; var googleAnalyticsOptions = {}; googleAnalyticsOptions['queryParameter'] = 'q'; googleAnalyticsOptions['categoryParameter'] = ''; customSearchOptions['googleAnalyticsOptions'] = googleAnalyticsOptions; var customSearchControl = new google.search.CustomSearchControl( '016171230611334810008:1hjujor5_fg', customSearchOptions); customSearchControl.setResultSetSize(google.search.Search.FILTERED_CSE_RESULTSET); var options = new google.search.DrawOptions(); options.setSearchFormRoot('cse-search-form'); customSearchControl.draw('cse', options); }, true);</script><link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" /><div id="cse" style="width:100%;"></div>
<div class="header"><a id="top" name="top"></a>
<table class="simple oac_no_warn" summary="" cellspacing="0" cellpadding="0" width="100%">
<tr>
<td align="left" valign="top"><div class="booktitle">Developing JAXB Applications Using EclipseLink MOXy,
<b>Release 2.7</b><br /></font></td>
<td valign="bottom" align="right" width="144">
<table class="simple oac_no_warn" summary="" cellspacing="0" cellpadding="0" width="100%">
<tr>
<td>&nbsp;</td>
<td align="center" valign="top"><a href="toc.htm"><img src="../../dcommon/images/contents.png" alt="Go To Table Of Contents" border="0" height="16" width="16" /><br />
</td><td>&nbsp;</td><td align="center"><a href="../../" target="_top" class="external text" title="Search" rel="nofollow"><img src="../../dcommon/images/search.png" alt="Search" style="border:0;" /><br /><span class="mini"></span></a></td><td>&nbsp;</td><td align="center"><a href="../eclipselink_moxy.pdf" title="PDF" target="_blank"><img src="../../dcommon/images/pdf_icon.png" style="padding-right:5px;border:0" alt="PDF"></a></td>
</tr>
</table>
</td>
</tr>
</table>
<hr />
<table class="navigation simple oac_no_warn" summary="" cellspacing="0" cellpadding="0" width="100" align="center">
<tr>
<td align="center"><a href="simple_values003.htm"><img src="../../dcommon/images/larrow.png" alt="Previous" border="0" height="16" width="16" /></a></td>
<td align="center"><a href="special_schema_types.htm"><img src="../../dcommon/images/rarrow.png" alt="Next" border="0" height="16" width="16" /></a></td>
<td>&nbsp;</td>
</tr>
</table>
</div>
<!-- class="header" -->
<div class="ind"><!-- End Header --><a id="CHDCGAIC" name="CHDCGAIC"></a><a id="TLJAX282" name="TLJAX282"></a>
<div class="sect1"><!-- infolevel="all" infotype="General" -->
<h1 class="sect1"><font face="arial, helvetica, sans-serif" color="#330099">Mapping Enums</font></h1>
<p>Java enums can be mapped to XML using the <code>@XmlEnum</code> and <code>@XmlEnumValue</code> annotations.</p>
<a id="TLJAX283" name="TLJAX283"></a>
<div class="sect2"><a id="sthref83" name="sthref83"></a>
<h2 class="sect2"><font face="arial, helvetica, sans-serif" color="#330099">Mapping Enums using Constant Names</font></h2>
<p>The following schema demonstrates an XML enumeration:</p>
<div class="example"><a id="TLJAX284" name="TLJAX284"></a><a id="sthref84" name="sthref84"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 4-40 Sample XML Schema</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;xs:simpleType name="CustomerType"&gt;
&lt;xs:restriction base="xs:string"/&gt;
&lt;xs:enumeration value="PROMO_CUSTOMER"/&gt;
&lt;xs:enumeration value="NEW_CUSTOMER"/&gt;
&lt;xs:enumeration value="VIP"/&gt;
&lt;xs:enumeration value="NORMAL"/&gt;
&lt;/xs:restriction&gt;
&lt;/xs:simpleType&gt;
</pre></div>
<!-- class="example" -->
<p>If your <code>enum</code> constant names themselves are sufficient for the XML representation, you can simply use the <code>@XmlEnum</code> annotation:</p>
<div class="example"><a id="TLJAX285" name="TLJAX285"></a><a id="sthref85" name="sthref85"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 4-41 Using the @XmlEnum Annotation</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
package example;
import javax.xml.bind.annotation.*;
@XmlRootElement
@XmlAccessorType(XmlAccessType.FIELD)
public class Customer {
private CustomerType type = CustomerType.NEW_CUSTOMER;
<strong>@XmlEnum</strong>(String.class)
private enum CustomerType { PROMO_CUSTOMER, NEW_CUSTOMER, VIP, NORMAL }
...
}
</pre></div>
<!-- class="example" -->
<p><a href="#CHDHJCBE">Example 4-42</a> shows how to define this mapping in EclipseLink OXM Metadata:</p>
<div class="example"><a id="CHDHJCBE" name="CHDHJCBE"></a><a id="TLJAX286" name="TLJAX286"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 4-42 Sample XML Mapping</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
...
&lt;xml-enums&gt;
&lt;xml-enum java-enum="CustomerType" value="java.lang.String"&gt;
&lt;xml-enum-value java-enum-value="PROMO_CUSTOMER"&gt;PROMO_CUSTOMER&lt;/xml-enum-value&gt;
&lt;xml-enum-value java-enum-value="NEW_CUSTOMER"&gt;NEW_CUSTOMER&lt;/xml-enum-value&gt;
&lt;xml-enum-value java-enum-value="VIP"&gt;VIP&lt;/xml-enum-value&gt;
&lt;xml-enum-value java-enum-value="NORMAL"&gt;NORMAL&lt;/xml-enum-value&gt;
&lt;/xml-enum&gt;
&lt;/xml-enums&gt;
&lt;java-types&gt;
&lt;java-type name="Customer"&gt;
&lt;xml-root-element name="customer"/&gt;
&lt;java-attributes&gt;
&lt;xml-element java-attribute="type" type="CustomerType"/&gt;
&lt;/java-attributes&gt;
&lt;/java-type&gt;
&lt;/java-types&gt;
...
</pre></div>
<!-- class="example" -->
<p>When marshalled to XML, a <strong>Customer</strong> would look like this:</p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;customer&gt;
&lt;type&gt;NEW_CUSTOMER&lt;/type&gt;
&lt;/customer&gt;
</pre></div>
<!-- class="sect2" -->
<a id="TLJAX287" name="TLJAX287"></a>
<div class="sect2"><a id="sthref86" name="sthref86"></a>
<h2 class="sect2"><font face="arial, helvetica, sans-serif" color="#330099">Mapping Enums to Custom XML Values</font></h2>
<p>Given the following XML schema enumeration:</p>
<div class="example"><a id="TLJAX288" name="TLJAX288"></a><a id="sthref87" name="sthref87"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 4-43 Sample XML Schema</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;xs:simpleType name="CustomerType"&gt;
&lt;xs:restriction base="xs:int"&gt;
&lt;xs:enumeration value="1"/&gt;
&lt;xs:enumeration value="2"/&gt;
&lt;xs:enumeration value="3"/&gt;
&lt;xs:enumeration value="4"/&gt;
&lt;/xs:restriction&gt;
&lt;/xs:simpleType&gt;
</pre></div>
<!-- class="example" -->
<p>To model this in Java, the <code>@XmlEnumValue</code> annotation is used to provide an XML value for each <code>enum</code> constant:</p>
<div class="example"><a id="TLJAX289" name="TLJAX289"></a><a id="sthref88" name="sthref88"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 4-44 Using the @XmlEnumValue Annotation</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
package example;
import javax.xml.bind.annotation.*;
@XmlRootElement
@XmlAccessorType(XmlAccessType.FIELD)
public class Customer {
private CustomerType type = CustomerType.NEW_CUSTOMER;
@XmlEnum(Integer.class)
private enum CustomerType {
<strong>@XmlEnumValue</strong>("1") PROMO_CUSTOMER,
<strong>@XmlEnumValu</strong>e("2") NEW_CUSTOMER,
<strong>@</strong><strong>XmlEnumValue</strong>("3") VIP,
<strong>@XmlEnumValue</strong>("4") NORMAL;
...
}
</pre></div>
<!-- class="example" -->
<p><a href="#CHDGHHFE">Example 4-45</a> shows how to define this mapping in EclipseLink OXM Metadata:</p>
<div class="example"><a id="CHDGHHFE" name="CHDGHHFE"></a><a id="TLJAX290" name="TLJAX290"></a>
<p><strong><em><font face="arial, helvetica, sans-serif">Example 4-45 Sample XML Mapping</font></em></strong></p>
<pre xml:space="preserve" class="oac_no_warn">
...
&lt;xml-enums&gt;
&lt;xml-enum java-enum="CustomerType" value="java.lang.Integer"&gt;
&lt;xml-enum-value java-enum-value="PROMO_CUSTOMER"&gt;1&lt;/xml-enum-value&gt;
&lt;xml-enum-value java-enum-value="NEW_CUSTOMER"&gt;2&lt;/xml-enum-value&gt;
&lt;xml-enum-value java-enum-value="VIP"&gt;3&lt;/xml-enum-value&gt;
&lt;xml-enum-value java-enum-value="NORMAL"&gt;4&lt;/xml-enum-value&gt;
&lt;/xml-enum&gt;
&lt;/xml-enums&gt;
&lt;java-types&gt;
&lt;java-type name="Customer"&gt;
&lt;xml-root-element name="customer"/&gt;
&lt;java-attributes&gt;
&lt;xml-element java-attribute="type" type="CustomerType"/&gt;
&lt;/java-attributes&gt;
&lt;/java-type&gt;
&lt;/java-types&gt;
...
</pre></div>
<!-- class="example" -->
<p>When marshalled to XML, a new <strong>Customer</strong> would look like this:</p>
<pre xml:space="preserve" class="oac_no_warn">
&lt;customer&gt;
&lt;type&gt;2&lt;/type&gt;
&lt;/customer&gt;
</pre></div>
<!-- class="sect2" --></div>
<!-- class="sect1" --></div>
<!-- class="ind" -->
<!-- Start Footer -->
<div class="footer">
<hr />
<table class="simple oac_no_warn" summary="" cellspacing="0" cellpadding="0" width="100%">
<col width="33%" />
<col width="*" />
<col width="33%" />
<tr>
<td valign="bottom">
<table class="navigation simple oac_no_warn" summary="" cellspacing="0" cellpadding="0" width="100" align="center">
<col width="*" />
<col width="48%" />
<col width="48%" />
<tr>
<td>&nbsp;</td>
<td align="center"><a href="simple_values003.htm"><img src="../../dcommon/images/larrow.png" alt="Previous" border="0" height="16" width="16" /></a></td>
<td align="center"><a href="special_schema_types.htm"><img src="../../dcommon/images/rarrow.png" alt="Next" border="0" height="16" width="16" /></a></td>
</tr>
</table>
</td>
<td align="center" width="34%"><a href="http://www.eclipse.org/eclipselink/" title="EclipseLink home"><img src="../../dcommon/images/ellogo.png" alt="EclipseLink" width="150" border="0" /></a><br />
<td valign="bottom" align="right">
<table class="simple oac_no_warn" summary="" cellspacing="0" cellpadding="0" width="225">
<tr>
<td>&nbsp;</td>
<td align="center" valign="top"><a href="toc.htm"><img src="../../dcommon/images/contents.png" alt="Go To Table Of Contents" border="0" height="16" width="16" /><br />
</td><td>&nbsp;</td><td align="center"><a href="../../" target="_top" class="external text" title="Search" rel="nofollow"><img src="../../dcommon/images/search.png" alt="Search" style="border:0;" /><br /><span class="mini"></span></a></td><td>&nbsp;</td><td align="center"><a href="../eclipselink_moxy.pdf" title="PDF" target="_blank"><img src="../../dcommon/images/pdf_icon.png" style="padding-right:5px;border:0" alt="PDF"></a></td>
</tr>
</table>
</td>
</tr>
</table>
</div>
<!-- class="footer" -->
<div id="copyright">Copyright &copy; 2013 by The Eclipse Foundation under the <a href="http://www.eclipse.org/org/documents/epl-v10.php">Eclipse Public License (EPL)</a><br /> <script type="text/javascript">var LastUpdated = document.lastModified;document.writeln ("Updated: " + LastUpdated);</script> </div><!-- START: Analytics --><script type="text/javascript"> var _gaq = _gaq || []; _gaq.push(['_setAccount', 'UA-1608008-2']); _gaq.push(['_trackPageview']); (function() { var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); })(); </script><!-- END: Analytics --><!-- START: Sharethis --><script>var options={ "publisher": "e2fe9e07-fab6-4f84-83ea-0991b429842c", "position": "right", "ad": { "visible": false, "openDelay": 5, "closeDelay": 0}};var st_hover_widget = new sharethis.widgets.hoverbuttons(options);</script><!-- END: Sharethis --></body>
</html>