• file
• revisions
• annotate
• diff
• comparison
• raw

src/share/jaxws_classes/javax/xml/bind/annotation/XmlEnum.java@9c07ef4934dd (annotated)

src/share/jaxws_classes/javax/xml/bind/annotation/XmlEnum.java

Thu, 31 Aug 2017 15:18:52 +0800

author

aoqi

date

Thu, 31 Aug 2017 15:18:52 +0800

changeset 637

9c07ef4934dd

parent 397

b99d7e355d4b

parent 0

373ffda63c9a

permissions

-rw-r--r--

merge

aoqi@0	1	/*
aoqi@0	2	* Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved.
aoqi@0	3	* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0	4	*
aoqi@0	5	* This code is free software; you can redistribute it and/or modify it
aoqi@0	6	* under the terms of the GNU General Public License version 2 only, as
aoqi@0	7	* published by the Free Software Foundation. Oracle designates this
aoqi@0	8	* particular file as subject to the "Classpath" exception as provided
aoqi@0	9	* by Oracle in the LICENSE file that accompanied this code.
aoqi@0	10	*
aoqi@0	11	* This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0	12	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0	13	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
aoqi@0	14	* version 2 for more details (a copy is included in the LICENSE file that
aoqi@0	15	* accompanied this code).
aoqi@0	16	*
aoqi@0	17	* You should have received a copy of the GNU General Public License version
aoqi@0	18	* 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0	19	* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0	20	*
aoqi@0	21	* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0	22	* or visit www.oracle.com if you need additional information or have any
aoqi@0	23	* questions.
aoqi@0	24	*/
aoqi@0	25
aoqi@0	26	package javax.xml.bind.annotation;
aoqi@0	27
aoqi@0	28	import static java.lang.annotation.ElementType.TYPE;
aoqi@0	29	import java.lang.annotation.Retention;
aoqi@0	30	import static java.lang.annotation.RetentionPolicy.RUNTIME;
aoqi@0	31	import java.lang.annotation.Target;
aoqi@0	32
aoqi@0	33	/**
aoqi@0	34	* <p>
aoqi@0	35	* Maps an enum type {@link Enum} to XML representation.
aoqi@0	36	*
aoqi@0	37	* <p>This annotation, together with {@link XmlEnumValue} provides a
aoqi@0	38	* mapping of enum type to XML representation.
aoqi@0	39	*
aoqi@0	40	* <p> <b>Usage</b> </p>
aoqi@0	41	* <p>
aoqi@0	42	* The <tt>@XmlEnum</tt> annotation can be used with the
aoqi@0	43	* following program elements:
aoqi@0	44	* <ul>
aoqi@0	45	* <li>enum type</li>
aoqi@0	46	* </ul>
aoqi@0	47	*
aoqi@0	48	* <p> The usage is subject to the following constraints:
aoqi@0	49	* <ul>
aoqi@0	50	* <li> This annotation can be used the following other annotations:
aoqi@0	51	* {@link XmlType},
aoqi@0	52	* {@link XmlRootElement} </li>
aoqi@0	53	* </ul>
aoqi@0	54	* <p>See "Package Specification" in javax.xml.bind.package javadoc for
aoqi@0	55	* additional common information </p>
aoqi@0	56	*
aoqi@0	57	* <p>An enum type is mapped to a schema simple type with enumeration
aoqi@0	58	* facets. The schema type is derived from the Java type to which
aoqi@0	59	* <tt>@XmlEnum.value()</tt>. Each enum constant <tt>@XmlEnumValue</tt>
aoqi@0	60	* must have a valid lexical representation for the type
aoqi@0	61	* <tt>@XmlEnum.value()</tt> .
aoqi@0	62	*
aoqi@0	63	* <p><b>Examples:</b> See examples in {@link XmlEnumValue}
aoqi@0	64	*
aoqi@0	65	* @since JAXB2.0
aoqi@0	66	*/
aoqi@0	67
aoqi@0	68	@Retention(RUNTIME) @Target({TYPE})
aoqi@0	69	public @interface XmlEnum {
aoqi@0	70	/**
aoqi@0	71	* Java type that is mapped to a XML simple type.
aoqi@0	72	*
aoqi@0	73	*/
aoqi@0	74	Class<?> value() default String.class;
aoqi@0	75	}