Jump to: navigation, search

Difference between revisions of "EclipseLink/UserGuide/MOXy/Simple Values/Enums"

(Mapping enum constant name)
(Mapping enum constant name)
Line 32: Line 32:
 
@XmlAccessorType(XmlAccessType.FIELD)
 
@XmlAccessorType(XmlAccessType.FIELD)
 
public class Customer {
 
public class Customer {
   @XmlElement(name="first-name")
+
   @XmlElement(name="type")
   private String firstName;
+
   private CustomerType type = CustomerType.NEW_CUSTOMER;
 +
 
 +
  ...
 +
 
 +
  @XmlEnum
 +
  public enum CustomerType { PROMO_CUSTOMER, NEW_CUSTOMER, VIP, NORMAL }
 +
 
 +
}
  
 
@XmlEnum
 
@XmlEnum

Revision as of 16:02, 14 January 2011

EclipseLink MOXy

link="http://wiki.eclipse.org/EclipseLink"
EclipseLink
Website
Download
Community
Mailing ListForumsIRC
Bugzilla
Open
Help Wanted
Bug Day
Contribute
Browse Source

Mapping Enums

Java enums can be mapped to XML using the @XmlEnum and @XmlEnumValue annotations.


Mapping enum constant name

The following schema demonstrates an XML enumeration:

<xs:simpleType name="CustomerType">
   <xs:restriction base="xs:string"/>
      <xs:enumeration value="PROMO_CUSTOMER"/>
      <xs:enumeration value="NEW_CUSTOMER"/>
      <xs:enumeration value="VIP"/>
      <xs:enumeration value="NORMAL"/>
</xs:simpleType>

If your enums constant names themselves are sufficient for the XML representation, you can simply use the @XmlEnum annotation:

@XmlAccessorType(XmlAccessType.FIELD)
public class Customer {
   @XmlElement(name="type")
   private CustomerType type = CustomerType.NEW_CUSTOMER;
 
   ...
 
   @XmlEnum
   public enum CustomerType { PROMO_CUSTOMER, NEW_CUSTOMER, VIP, NORMAL }
 
}
 
@XmlEnum
public enum CustomerType { PROMO_CUSTOMER, NEW_CUSTOMER, VIP, NORMAL }

When marshalled to XML, an Person would look like this:

<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>

Mapping enum constant name(value)

This code:

     @XmlType
     @XmlEnum(Integer.class)
     public enum Coin { 
         @XmlEnumValue("1") PENNY(1),
         @XmlEnumValue("5") NICKEL(5),
         @XmlEnumValue("10") DIME(10),
         @XmlEnumValue("25") QUARTER(25) }

will generate the following XML schema:

     <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>

Eclipselink-logo.gif
Version: 2.2.0 Draft
Other versions...