Java tutorial
/* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * * Copyright (c) 2004-2017 Oracle and/or its affiliates. All rights reserved. * * The contents of this file are subject to the terms of either the GNU * General Public License Version 2 only ("GPL") or the Common Development * and Distribution License("CDDL") (collectively, the "License"). You * may not use this file except in compliance with the License. You can * obtain a copy of the License at * https://oss.oracle.com/licenses/CDDL+GPL-1.1 * or LICENSE.txt. See the License for the specific * language governing permissions and limitations under the License. * * When distributing the software, include this License Header Notice in each * file and include the License file at LICENSE.txt. * * GPL Classpath Exception: * Oracle designates this particular file as subject to the "Classpath" * exception as provided by Oracle in the GPL Version 2 section of the License * file that accompanied this code. * * Modifications: * If applicable, add the following below the License Header, with the fields * enclosed by brackets [] replaced by your own identifying information: * "Portions Copyright [year] [name of copyright owner]" * * Contributor(s): * If you wish your version of this file to be governed by only the CDDL or * only the GPL Version 2, indicate your decision by adding "[Contributor] * elects to include this software in this distribution under the [CDDL or GPL * Version 2] license." If you don't indicate a single choice of license, a * recipient has the option to distribute your version of this file under * either the CDDL, the GPL Version 2 or to extend the choice of license to * its licensees as provided above. However, if you add GPL Version 2 code * and therefore, elected the GPL Version 2 license, then the option applies * only if the new code is made subject to such option by the copyright * holder. */ 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. * * <p> <b>Usage</b> </p> * * <p> The {@code @XmlEnumValue} annotation can be used with the * following program elements: * <ul> * <li>enum constant</li> * </ul> * * <p>See "Package Specification" in javax.xml.bind.package javadoc for * additional common information.</p> * * <p>This annotation, together with {@link XmlEnum} 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()}. Each enum constant {@code @XmlEnumValue} * must have a valid lexical representation for the type * {@code @XmlEnum.value()} * * <p> In the absence of this annotation, {@link Enum#name()} is used * as the XML representation. * * <p> <b>Example 1: </b>Map enum constant name {@literal ->} 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> * }</pre> * * <p><b>Example 2: </b>Map enum constant name(value) {@literal ->} 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> * }</pre> * * <p><b>Example 3: </b>Map enum constant name {@literal ->} 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> * }</pre> * * @since 1.6, JAXB 2.0 */ @Retention(RUNTIME) @Target({ FIELD }) public @interface XmlEnumValue { String value(); }