jakarta.xml.bind.annotation.XmlEnumValue Maven / Gradle / Ivy
/*
* Copyright (c) 2004, 2021 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 {@link Enum} type to XML representation.
*
* Usage
*
* The {@code @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 {@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
* {@code @XmlEnum.value()}. Each enum constant {@code @XmlEnumValue}
* must have a valid lexical representation for the type
* {@code @XmlEnum.value()}
*
*
In the absence of this annotation, {@link Enum#name()} is used
* as the XML representation.
*
*
Example 1: Map enum constant name {@literal ->} enumeration facet
*
* //Example: Code fragment
* @XmlEnum(String.class)
* public enum Card { CLUBS, DIAMONDS, HEARTS, SPADES }
* {@code
*
*
*
*
* }
*
* Example 2: Map enum constant name(value) {@literal ->} 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) }
* {@code
*
*
*
*
*
*
* }
*
* Example 3: Map enum constant name {@literal ->} enumeration facet
*
*
* //Code fragment
* @XmlType
* @XmlEnum(Integer.class)
* public enum Code {
* @XmlEnumValue("1") ONE,
* @XmlEnumValue("2") TWO;
* }
* {@code
*
*
*
*
*
*
* }
*
* @since 1.6, JAXB 2.0
*/
@Retention(RUNTIME)
@Target({FIELD})
public @interface XmlEnumValue {
String value();
}