/*
 * Copyright (c) 2004, 2020 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Distribution License v. 1.0, which is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */

package jakarta.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 Enum type to XML representation.

Usage

The @XmlEnumValue annotation can be used with the following program elements:

  • enum constant

See "Package Specification" in jakarta.xml.bind.package javadoc for additional common information.

This annotation, together with 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, 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:1.6, JAXB 2.0
/** * 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 jakarta.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 * &#64;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 * &#64;XmlType * &#64;XmlEnum(Integer.class) * public enum Coin { * &#64;XmlEnumValue("1") PENNY(1), * &#64;XmlEnumValue("5") NICKEL(5), * &#64;XmlEnumValue("10") DIME(10), * &#64;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 * &#64;XmlType * &#64;XmlEnum(Integer.class) * public enum Code { * &#64;XmlEnumValue("1") ONE, * &#64;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(); }