javax.xml.bind.annotation.XmlEnum Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2004-2010 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
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;
}