/* * Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as * published by the Free Software Foundation. Oracle designates this * particular file as subject to the "Classpath" exception as provided * by Oracle in the LICENSE file that accompanied this code. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License * version 2 for more details (a copy is included in the LICENSE file that * accompanied this code). * * You should have received a copy of the GNU General Public License version * 2 along with this work; if not, write to the Free Software Foundation, * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. * * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA * or visit www.oracle.com if you need additional information or have any * questions. */ package javax.xml.bind.annotation; import java.lang.annotation.Retention; import java.lang.annotation.Target; import static java.lang.annotation.RetentionPolicy.RUNTIME; import static java.lang.annotation.ElementType.FIELD; /** * Maps an enum constant in {@link Enum} type to XML representation. * *
Usage
* *The @XmlEnumValue annotation can be used with the * following program elements: *
See "Package Specification" in javax.xml.bind.package javadoc for * additional common information.
* *This annotation, together with {@link XmlEnum} provides a * mapping of enum type to XML representation. * *
An enum type is mapped to a schema simple type with enumeration * facets. The schema type is derived from the Java type specified in * @XmlEnum.value(). Each enum constant @XmlEnumValue * must have a valid lexical representation for the type * @XmlEnum.value() * *
In the absence of this annotation, {@link Enum#name()} is used * as the XML representation. * *
Example 1: Map enum constant name -> enumeration facet
** //Example: Code fragment * @XmlEnum(String.class) * public enum Card { CLUBS, DIAMONDS, HEARTS, SPADES } * * <!-- 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> ** *
Example 2: Map enum constant name(value) -> enumeration facet
** //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) } * * <!-- 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> ** *
Example 3: Map enum constant name -> enumeration facet
* ** //Code fragment * @XmlType * @XmlEnum(Integer.class) * public enum Code { * @XmlEnumValue("1") ONE, * @XmlEnumValue("2") TWO; * } * * <!-- 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> ** * @since JAXB 2.0 */ @Retention(RUNTIME) @Target({FIELD}) public @interface XmlEnumValue { String value(); }