|
|
| (23 intermediate revisions by 2 users not shown) |
| Line 1: |
Line 1: |
| − | {{EclipseLink_UserGuide
| + | Please see http://www.eclipse.org/eclipselink/documentation/2.4/moxy/simple_values004.htm |
| − | |info=y
| + | |
| − | |toc=y
| + | |
| − | |eclipselink=y
| + | |
| − | |eclipselinktype=MOXy
| + | |
| − | |api=y
| + | |
| − | |apis= * [http://www.eclipse.org/eclipselink/api/latest/index.html?javax/xml/bind/annotation/XmlEnumValue.html XmlEnumValue]
| + | |
| − | * [http://www.eclipse.org/eclipselink/api/latest/index.html?javax/xml/bind/annotation/XmlEnum.html XmlEnum]
| + | |
| − | }}
| + | |
| − | | + | |
| − | =Mapping Enums=
| + | |
| − | Java '''enum'''s can be mapped to XML using the '''@XmlEnum''' and '''@XmlEnumValue''' annotations.
| + | |
| − | | + | |
| − | | + | |
| − | ==Mapping enum constant name==
| + | |
| − | | + | |
| − | The following schema demonstrates an XML enumeration:
| + | |
| − | | + | |
| − | <source lang="xml">
| + | |
| − | <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>
| + | |
| − | </source>
| + | |
| − | | + | |
| − | If your '''enum''' constant names themselves are sufficient for the XML representation, you can simply use the '''@XmlEnum''' annotation:
| + | |
| − | | + | |
| − | <source lang="java">
| + | |
| − | @XmlRootElement
| + | |
| − | @XmlAccessorType(XmlAccessType.FIELD)
| + | |
| − | public class Customer {
| + | |
| − | private CustomerType type = CustomerType.NEW_CUSTOMER;
| + | |
| − | | + | |
| − | @XmlEnum(String.class)
| + | |
| − | private enum CustomerType { PROMO_CUSTOMER, NEW_CUSTOMER, VIP, NORMAL }
| + | |
| − | | + | |
| − | ...
| + | |
| − | }
| + | |
| − | </source>
| + | |
| − | | + | |
| − | When marshalled to XML, a '''Customer''' would look like this:
| + | |
| − | | + | |
| − | <source lang="xml">
| + | |
| − | <customer>
| + | |
| − | <type>NEW_CUSTOMER</type>
| + | |
| − | </customer>
| + | |
| − | </source>
| + | |
| − | | + | |
| − | | + | |
| − | ==Mapping enum with Values==
| + | |
| − | | + | |
| − | For non-String enumerations, such as:
| + | |
| − | | + | |
| − | <source lang="xml">
| + | |
| − | <xs:simpleType name="RewardLevel">
| + | |
| − | <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>
| + | |
| − | </source>
| + | |
| − | | + | |
| − | The '''@XmlEnumValue''' annotation is used to provide an XML value for each enum constant:
| + | |
| − | | + | |
| − | <source lang="java">
| + | |
| − | @XmlRootElement
| + | |
| − | @XmlAccessorType(XmlAccessType.FIELD)
| + | |
| − | public class Customer {
| + | |
| − | | + | |
| − | private RewardLevel discount = RewardLevel.NONE;
| + | |
| − | | + | |
| − | @XmlEnum(Integer.class)
| + | |
| − | private enum RewardLevel {
| + | |
| − | @XmlEnumValue("0") NONE(0),
| + | |
| − | @XmlEnumValue("5") BRONZE(5),
| + | |
| − | @XmlEnumValue("10") SILVER(10),
| + | |
| − | @XmlEnumValue("25") GOLD(25),
| + | |
| − | @XmlEnumValue("40") PLATINUM(40);
| + | |
| − | | + | |
| − | ...
| + | |
| − | }
| + | |
| − | </source>
| + | |
| − | | + | |
| − | When marshalled to XML, a '''Customer''' would look like this:
| + | |
| − | | + | |
| − | <source lang="xml">
| + | |
| − | <customer>
| + | |
| − | <discount>0</discount>
| + | |
| − | </customer>
| + | |
| − | </source>
| + | |
| − | | + | |
| − | | + | |
| − | {{EclipseLink_MOXy
| + | |
| − | |previous= [[EclipseLink/UserGuide/MOXy/Simple_Values/Collections/XMLDirectCollectionMapping|Mapping collections of Simple Values]]
| + | |
| − | |next= [[EclipseLink/UserGuide/MOXy/Simple_Values/Special_Schema_Types|Special Schema Types]]
| + | |
| − | |up= [[EclipseLink/UserGuide/MOXy/Simple_Values|Simple Values]]
| + | |
| − | |version=2.2.0 Draft
| + | |
| − | }}
| + | |
