XmlEnum (Java EE 5 SDK) - Java Platform, Enterprise Edition v5.0 API Specifications

Overview

Package

Class

Tree

Deprecated

Index

Help

Java EE 5 SDK

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

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

Since:: JAXB2.0

Optional Element Summary

Class<?> value
Java type that is mapped to a XML simple type.

Optional Element Summary
`Class<?>`	`value` Java type that is mapped to a XML simple type.

value

public abstract Class<?> value

Java type that is mapped to a XML simple type.

Default:: java.lang.String.class