|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: REQUIRED | OPTIONAL | DETAIL: ELEMENT |
javax.xml.bind.annotation Annotation Type XmlEnumValue
@Target(value=FIELD)
将
Enum
类型中的枚举常量映射到 XML 表示形式。
用法
@XmlEnumValue 注释可以与以下程序元素一起使用:
- 枚举常量
有关其他公共信息,请参阅 javax.xml.bind.package javadoc 中的“包规范”。
此注释以及 XmlEnum
提供枚举类型到 XML 表示形式的映射。
枚举类型被映射到带有 enumeration facet 的模式简单类型。模式类型派生于 @XmlEnum.value() 中指定的 Java 类型。每个枚举常量 @XmlEnumValue 都必须有一个用于 @XmlEnum.value() 类型的有效词法表示形式。
在没有此注释的情况下,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>
since | JAXB 2.0 |
Maps an enum constant in Enum
type to XML representation.
Usage
The @XmlEnumValue annotation can be used with the following program elements:
- enum constant
See "Package Specification" in javax.xml.bind.package javadoc for additional common information.
This annotation, together with XmlEnum
provides a
mapping of enum type to XML representation.
An enum type is mapped to a schema simple type with enumeration facets. The schema type is derived from the Java type specified in @XmlEnum.value(). Each enum constant @XmlEnumValue must have a valid lexical representation for the type @XmlEnum.value()
In the absence of this annotation, Enum.name()
is used
as the XML representation.
Example 1: Map enum constant name -> 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>
Example 2: Map enum constant name(value) -> 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>
Example 3: Map enum constant name -> 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>
- Since:
- JAXB 2.0
Required Element Summary | |
---|---|
String |
value
|
Element Detail |
---|
abstract public String
value()
英文文档:
value
public abstract String value
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: REQUIRED | OPTIONAL | DETAIL: ELEMENT |
Submit a bug or feature
Copyright 2007 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.
PS : 未经我党受权你也可自由散发此文档。 如有任何错误请自行修正;若因此而造成任何损失请直接找人民主席,请勿与本人联系。谢谢!