Source Code Cross Referenced for XmlEnumValue.java in  » 6.0-JDK-Modules » jaxb-api » javax » xml » bind » annotation » Java Source Code / Java DocumentationJava Source Code and Java Documentation

001:        /*
002:         * Copyright 2004 Sun Microsystems, Inc. All rights reserved.
003:         * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
004:         */
005:
006:        package javax.xml.bind.annotation;
007:
008:        import java.lang.annotation.Retention;
009:        import java.lang.annotation.Target;
010:        import static java.lang.annotation.RetentionPolicy.RUNTIME;
011:        import static java.lang.annotation.ElementType.FIELD;
012:
013:        /**
014:         * Maps an enum constant in {@link Enum} type to XML representation.  
015:         * 
016:         * <p> <b>Usage</b> </p>
017:         *
018:         * <p> The <tt>@XmlEnumValue</tt> annotation can be used with the
019:         *     following program elements:  
020:         * <ul> 
021:         *   <li>enum constant</li>
022:         * </ul>
023:         *
024:         * <p>See "Package Specification" in javax.xml.bind.package javadoc for
025:         * additional common information.</p>
026:         *
027:         * <p>This annotation, together with {@link XmlEnum} provides a
028:         * mapping of enum type to XML representation.
029:         *
030:         * <p>An enum type is mapped to a schema simple type with enumeration
031:         * facets. The schema type is derived from the Java type specified in
032:         * <tt>@XmlEnum.value()</tt>. Each enum constant <tt>@XmlEnumValue</tt>
033:         * must have a valid lexical representation for the type
034:         * <tt>@XmlEnum.value()</tt> 
035:         *
036:         * <p> In the absence of this annotation, {@link Enum#name()} is used
037:         * as the XML representation.
038:         *
039:         * <p> <b>Example 1: </b>Map enum constant name -> enumeration facet</p>
040:         * <pre>
041:         *     //Example: Code fragment
042:         *     &#64;XmlEnum(String.class)
043:         *     public enum Card { CLUBS, DIAMONDS, HEARTS, SPADES }
044:         *
045:         *     &lt;!-- Example: XML Schema fragment -->
046:         *     &lt;xs:simpleType name="Card">
047:         *       &lt;xs:restriction base="xs:string"/>
048:         *         &lt;xs:enumeration value="CLUBS"/>
049:         *         &lt;xs:enumeration value="DIAMONDS"/>
050:         *         &lt;xs:enumeration value="HEARTS"/>
051:         *         &lt;xs:enumeration value="SPADES"/>
052:         *     &lt;/xs:simpleType>
053:         * </pre>
054:         *
055:         * <p><b>Example 2: </b>Map enum constant name(value) -> enumeration facet </p>
056:         * <pre>
057:         *     //Example: code fragment
058:         *     &#64;XmlType
059:         *     &#64;XmlEnum(Integer.class)
060:         *     public enum Coin { 
061:         *         &#64;XmlEnumValue("1") PENNY(1),
062:         *         &#64;XmlEnumValue("5") NICKEL(5),
063:         *         &#64;XmlEnumValue("10") DIME(10),
064:         *         &#64;XmlEnumValue("25") QUARTER(25) }
065:         *
066:         *     &lt;!-- Example: XML Schema fragment -->
067:         *     &lt;xs:simpleType name="Coin">
068:         *       &lt;xs:restriction base="xs:int">
069:         *         &lt;xs:enumeration value="1"/>
070:         *         &lt;xs:enumeration value="5"/>
071:         *         &lt;xs:enumeration value="10"/>
072:         *         &lt;xs:enumeration value="25"/>
073:         *       &lt;/xs:restriction>
074:         *     &lt;/xs:simpleType>
075:         * </pre>
076:         *
077:         * <p><b>Example 3: </b>Map enum constant name -> enumeration facet </p>
078:         * 
079:         * <pre>
080:         *     //Code fragment
081:         *     &#64;XmlType
082:         *     &#64;XmlEnum(Integer.class)
083:         *     public enum Code {
084:         *         &#64;XmlEnumValue("1") ONE,
085:         *         &#64;XmlEnumValue("2") TWO;
086:         *     }
087:         * 
088:         *     &lt;!-- Example: XML Schema fragment -->
089:         *     &lt;xs:simpleType name="Code">
090:         *       &lt;xs:restriction base="xs:int">
091:         *         &lt;xs:enumeration value="1"/>
092:         *         &lt;xs:enumeration value="2"/>
093:         *       &lt;/xs:restriction>
094:         *     &lt;/xs:simpleType>
095:         * </pre>
096:         *
097:         * @since JAXB 2.0
098:         */
099:        @Retention(RUNTIME)
100:        @Target({FIELD})
101:        public @interface XmlEnumValue {
102:            String value();
103:        }