javax.xml.bind.annotation.XmlEnum Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2004 Sun Microsystems, Inc. All rights reserved.
 * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
 */

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;

/**
 * 
 * Maps an enum type {@link Enum} to XML representation.
 *
 * 
This annotation, together with {@link 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: 
 *         {@link XmlType},
 *         {@link 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 {@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;
}