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

src/share/jaxws_classes/javax/xml/bind/annotation/XmlEnum.java@0989ad8c0860 (annotated)

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

Tue, 09 Apr 2013 14:51:13 +0100

author

alanb

date

Tue, 09 Apr 2013 14:51:13 +0100

changeset 368

0989ad8c0860

parent 286

f50545b5e2f1

child 397

b99d7e355d4b

permissions

-rw-r--r--

8010393: Update JAX-WS RI to 2.2.9-b12941
Reviewed-by: alanb, erikj
Contributed-by: miroslav.kos@oracle.com, martin.grebac@oracle.com

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