JavaTM 2 Platform
Standard Ed. 6

javax.xml.bind.annotation
註釋型別 XmlEnumValue


@Retention(value=RUNTIME)
@Target(value=FIELD)
public @interface XmlEnumValue

Enum 型別中的列舉常數映射到 XML 表示形式。

用法

@XmlEnumValue 註釋可以與以下程序元素一起使用:

有關其他公共資訊,請參閱 javax.xml.bind.package javadoc 中的“套件規範”。

此註釋以及 XmlEnum 提供列舉型別到 XML 表示形式的映射。

列舉型別被映射到帶有 enumeration facet 的網要簡單型別。網要型別派生於 @XmlEnum.value() 中指定的 Java 型別。每個列舉常數 @XmlEnumValue 都必須有一個用於 @XmlEnum.value() 型別的有效詞法表示形式。

在沒有此註釋的情況下,Enum.name() 用作 XML 表示形式。

範例 1:映射列舉常數名稱 -> 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>
 

範例 2:映射列舉常數名稱(值) -> 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>
 

範例 3:映射列舉常數名稱 -> 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>
 

從以下版本開始:
JAXB 2.0

必需元素摘要
 String value
           
 

元素詳細資訊

value

public abstract String value

JavaTM 2 Platform
Standard Ed. 6

提交錯誤或意見

版權所有 2008 Sun Microsystems, Inc. 保留所有權利。請遵守GNU General Public License, version 2 only