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