Module jakarta.xml.bind
Package jakarta.xml.bind.annotation

Annotation Type XmlEnum

  • @Retention(RUNTIME)
@Target(TYPE)
public @interface XmlEnum

    Maps an enum type Enum to XML representation.

    This annotation, together with XmlEnumValue provides a mapping of enum type to XML representation.

    Usage

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

    • enum type

    The usage is subject to the following constraints:

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

    An enum type is mapped to a schema simple type with enumeration facets. The schema type is derived from the Java type to which @XmlEnum.value(). Each enum constant @XmlEnumValue must have a valid lexical representation for the type @XmlEnum.value().

    Examples: See examples in XmlEnumValue

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.Class<?> value
      Java type that is mapped to a XML simple type.

    • Element Detail

      • value

        java.lang.Class<?> value
        Java type that is mapped to a XML simple type.
        Default:
        java.lang.String.class