XmlEnumValue (Java Platform SE 6) - JavaTM 2 Platform Standard Edition 6.0 API 规范中文版

概述

软件包

类

使用

树

已过时

索引

帮助

Java^TM 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>