jaxws/src/java.xml.bind/share/classes/javax/xml/bind/annotation/XmlEnumValue.java
equal
deleted
inserted
replaced
33 /** |
33 /** |
34 * Maps an enum constant in {@link Enum} type to XML representation. |
34 * Maps an enum constant in {@link Enum} type to XML representation. |
35 * |
35 * |
36 * <p> <b>Usage</b> </p> |
36 * <p> <b>Usage</b> </p> |
37 * |
37 * |
38 * <p> The <tt>@XmlEnumValue</tt> annotation can be used with the |
38 * <p> The {@code @XmlEnumValue} annotation can be used with the |
39 * following program elements: |
39 * following program elements: |
40 * <ul> |
40 * <ul> |
41 * <li>enum constant</li> |
41 * <li>enum constant</li> |
42 * </ul> |
42 * </ul> |
43 * |
43 * |
47 * <p>This annotation, together with {@link XmlEnum} provides a |
47 * <p>This annotation, together with {@link XmlEnum} provides a |
48 * mapping of enum type to XML representation. |
48 * mapping of enum type to XML representation. |
49 * |
49 * |
50 * <p>An enum type is mapped to a schema simple type with enumeration |
50 * <p>An enum type is mapped to a schema simple type with enumeration |
51 * facets. The schema type is derived from the Java type specified in |
51 * facets. The schema type is derived from the Java type specified in |
52 * <tt>@XmlEnum.value()</tt>. Each enum constant <tt>@XmlEnumValue</tt> |
52 * {@code @XmlEnum.value()}. Each enum constant {@code @XmlEnumValue} |
53 * must have a valid lexical representation for the type |
53 * must have a valid lexical representation for the type |
54 * <tt>@XmlEnum.value()</tt> |
54 * {@code @XmlEnum.value()} |
55 * |
55 * |
56 * <p> In the absence of this annotation, {@link Enum#name()} is used |
56 * <p> In the absence of this annotation, {@link Enum#name()} is used |
57 * as the XML representation. |
57 * as the XML representation. |
58 * |
58 * |
59 * <p> <b>Example 1: </b>Map enum constant name {@literal ->} enumeration facet</p> |
59 * <p> <b>Example 1: </b>Map enum constant name {@literal ->} enumeration facet</p> |