/*
* Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package javax.xml.bind.annotation;
import static java.lang.annotation.ElementType.TYPE;
import java.lang.annotation.Retention;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
import java.lang.annotation.Target;
/**
* <p>
* Maps an enum type {@link Enum} to XML representation.
*
* <p>This annotation, together with {@link XmlEnumValue} provides a
* mapping of enum type to XML representation.
*
* <p> <b>Usage</b> </p>
* <p>
* The <tt>@XmlEnum</tt> annotation can be used with the
* following program elements:
* <ul>
* <li>enum type</li>
* </ul>
*
* <p> The usage is subject to the following constraints:
* <ul>
* <li> This annotation can be used the following other annotations:
* {@link XmlType},
* {@link XmlRootElement} </li>
* </ul>
* <p>See "Package Specification" in javax.xml.bind.package javadoc for
* additional common information </p>
*
* <p>An enum type is mapped to a schema simple type with enumeration
* facets. The schema type is derived from the Java type to which
* <tt>@XmlEnum.value()</tt>. Each enum constant <tt>@XmlEnumValue</tt>
* must have a valid lexical representation for the type
* <tt>@XmlEnum.value()</tt> .
*
* <p><b>Examples:</b> See examples in {@link XmlEnumValue}
*
* @since JAXB2.0
*/
@Retention(RUNTIME) @Target({TYPE})
public @interface XmlEnum {
/**
* Java type that is mapped to a XML simple type.
*
*/
Class<?> value() default String.class;
}