XmlEnum (Java EE 5)

Java EE API

previous page next page

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: REQUIRED | OPTIONAL

DETAIL: ELEMENT

javax.xml.bind.annotation Annotation Type XmlEnum

@Retention(value=RUNTIME) @Target(value=TYPE) public @interface XmlEnum

Implements: Annotation

@Retention(value=RUNTIME)
@Target(value=TYPE)

将枚举类型 Enum 映射到 XML 表示形式。

此注释以及 XmlEnumValue 提供了枚举类型到 XML 表示形式的映射。

用法

@XmlEnum 注释能够与以下程序元素一起使用：

枚举类型

用法受到以下约束的限制：

此注释能够与以下其他注释一起使用：XmlType 和 XmlRootElement。

有关公共信息，请参阅 javax.xml.bind.package javadoc 中的“包规范”。

枚举类型被映射到带有 enumeration facet 的模式简单类型。模式类型派生于 @XmlEnum.value() 中指定的 Java 类型。每个枚举常量 @XmlEnumValue 都必须有一个用于 @XmlEnum.value() 类型的有效词法表示形式。

示例：请参阅 XmlEnumValue 中的示例。

since

JAXB2.0

英文文档：

Maps an enum type Enum to XML representation.

This annotation, together with XmlEnumValue provides a mapping of enum type to XML representation.

Usage

The @XmlEnum annotation can be used with the following program elements:

enum type

The usage is subject to the following constraints:

This annotation can be used the following other annotations: XmlType, XmlRootElement

See "Package Specification" in javax.xml.bind.package javadoc for additional common information

An enum type is mapped to a schema simple type with enumeration facets. The schema type is derived from the Java type to which @XmlEnum.value(). Each enum constant @XmlEnumValue must have a valid lexical representation for the type @XmlEnum.value() .

Examples: See examples in XmlEnumValue