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

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

src/share/jaxws_classes/javax/xml/bind/annotation/XmlElements.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 javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
aoqi@0	29	import static java.lang.annotation.RetentionPolicy.RUNTIME;
aoqi@0	30	import static java.lang.annotation.ElementType.FIELD;
aoqi@0	31	import static java.lang.annotation.ElementType.METHOD;
aoqi@0	32	import java.lang.annotation.Retention;
aoqi@0	33	import java.lang.annotation.Target;
aoqi@0	34
aoqi@0	35	/**
aoqi@0	36	* <p>
aoqi@0	37	* A container for multiple @{@link XmlElement} annotations.
aoqi@0	38	*
aoqi@0	39	* Multiple annotations of the same type are not allowed on a program
aoqi@0	40	* element. This annotation therefore serves as a container annotation
aoqi@0	41	* for multiple &#64;XmlElements as follows:
aoqi@0	42	*
aoqi@0	43	* <pre>
aoqi@0	44	* &#64;XmlElements({ @XmlElement(...),@XmlElement(...) })
aoqi@0	45	* </pre>
aoqi@0	46	*
aoqi@0	47	* <p>The <tt>@XmlElements</tt> annnotation can be used with the
aoqi@0	48	* following program elements: </p>
aoqi@0	49	* <ul>
aoqi@0	50	* <li> a JavaBean property </li>
aoqi@0	51	* <li> non static, non transient field </li>
aoqi@0	52	* </ul>
aoqi@0	53	*
aoqi@0	54	* This annotation is intended for annotation a JavaBean collection
aoqi@0	55	* property (e.g. List).
aoqi@0	56	*
aoqi@0	57	* <p><b>Usage</b></p>
aoqi@0	58	*
aoqi@0	59	* <p>The usage is subject to the following constraints:
aoqi@0	60	* <ul>
aoqi@0	61	* <li> This annotation can be used with the following
aoqi@0	62	* annotations: @{@link XmlIDREF}, @{@link XmlElementWrapper}. </li>
aoqi@0	63	* <li> If @XmlIDREF is also specified on the JavaBean property,
aoqi@0	64	* then each &#64;XmlElement.type() must contain a JavaBean
aoqi@0	65	* property annotated with <tt>&#64;XmlID</tt>.</li>
aoqi@0	66	* </ul>
aoqi@0	67	*
aoqi@0	68	* <p>See "Package Specification" in javax.xml.bind.package javadoc for
aoqi@0	69	* additional common information.</p>
aoqi@0	70	*
aoqi@0	71	* <hr>
aoqi@0	72	*
aoqi@0	73	* <p><b>Example 1:</b> Map to a list of elements</p>
aoqi@0	74	* <pre>
aoqi@0	75	*
aoqi@0	76	* // Mapped code fragment
aoqi@0	77	* public class Foo {
aoqi@0	78	* &#64;XmlElements(
aoqi@0	79	* &#64;XmlElement(name="A", type=Integer.class),
aoqi@0	80	* &#64;XmlElement(name="B", type=Float.class)
aoqi@0	81	* }
aoqi@0	82	* public List items;
aoqi@0	83	* }
aoqi@0	84	*
aoqi@0	85	* &lt;!-- XML Representation for a List of {1,2.5}
aoqi@0	86	* XML output is not wrapped using another element -->
aoqi@0	87	* ...
aoqi@0	88	* &lt;A> 1 &lt;/A>
aoqi@0	89	* &lt;B> 2.5 &lt;/B>
aoqi@0	90	* ...
aoqi@0	91	*
aoqi@0	92	* &lt;!-- XML Schema fragment -->
aoqi@0	93	* &lt;xs:complexType name="Foo">
aoqi@0	94	* &lt;xs:sequence>
aoqi@0	95	* &lt;xs:choice minOccurs="0" maxOccurs="unbounded">
aoqi@0	96	* &lt;xs:element name="A" type="xs:int"/>
aoqi@0	97	* &lt;xs:element name="B" type="xs:float"/>
aoqi@0	98	* &lt;xs:choice>
aoqi@0	99	* &lt;/xs:sequence>
aoqi@0	100	* &lt;/xs:complexType>
aoqi@0	101	*
aoqi@0	102	* </pre>
aoqi@0	103	*
aoqi@0	104	* <p><b>Example 2:</b> Map to a list of elements wrapped with another element
aoqi@0	105	* </p>
aoqi@0	106	* <pre>
aoqi@0	107	*
aoqi@0	108	* // Mapped code fragment
aoqi@0	109	* public class Foo {
aoqi@0	110	* &#64;XmlElementWrapper(name="bar")
aoqi@0	111	* &#64;XmlElements(
aoqi@0	112	* &#64;XmlElement(name="A", type=Integer.class),
aoqi@0	113	* &#64;XmlElement(name="B", type=Float.class)
aoqi@0	114	* }
aoqi@0	115	* public List items;
aoqi@0	116	* }
aoqi@0	117	*
aoqi@0	118	* &lt;!-- XML Schema fragment -->
aoqi@0	119	* &lt;xs:complexType name="Foo">
aoqi@0	120	* &lt;xs:sequence>
aoqi@0	121	* &lt;xs:element name="bar">
aoqi@0	122	* &lt;xs:complexType>
aoqi@0	123	* &lt;xs:choice minOccurs="0" maxOccurs="unbounded">
aoqi@0	124	* &lt;xs:element name="A" type="xs:int"/>
aoqi@0	125	* &lt;xs:element name="B" type="xs:float"/>
aoqi@0	126	* &lt;/xs:choice>
aoqi@0	127	* &lt;/xs:complexType>
aoqi@0	128	* &lt;/xs:element>
aoqi@0	129	* &lt;/xs:sequence>
aoqi@0	130	* &lt;/xs:complexType>
aoqi@0	131	* </pre>
aoqi@0	132	*
aoqi@0	133	* <p><b>Example 3:</b> Change element name based on type using an adapter.
aoqi@0	134	* </p>
aoqi@0	135	* <pre>
aoqi@0	136	* class Foo {
aoqi@0	137	* &#64;XmlJavaTypeAdapter(QtoPAdapter.class)
aoqi@0	138	* &#64;XmlElements({
aoqi@0	139	* &#64;XmlElement(name="A",type=PX.class),
aoqi@0	140	* &#64;XmlElement(name="B",type=PY.class)
aoqi@0	141	* })
aoqi@0	142	* Q bar;
aoqi@0	143	* }
aoqi@0	144	*
aoqi@0	145	* &#64;XmlType abstract class P {...}
aoqi@0	146	* &#64;XmlType(name="PX") class PX extends P {...}
aoqi@0	147	* &#64;XmlType(name="PY") class PY extends P {...}
aoqi@0	148	*
aoqi@0	149	* &lt;!-- XML Schema fragment -->
aoqi@0	150	* &lt;xs:complexType name="Foo">
aoqi@0	151	* &lt;xs:sequence>
aoqi@0	152	* &lt;xs:element name="bar">
aoqi@0	153	* &lt;xs:complexType>
aoqi@0	154	* &lt;xs:choice minOccurs="0" maxOccurs="unbounded">
aoqi@0	155	* &lt;xs:element name="A" type="PX"/>
aoqi@0	156	* &lt;xs:element name="B" type="PY"/>
aoqi@0	157	* &lt;/xs:choice>
aoqi@0	158	* &lt;/xs:complexType>
aoqi@0	159	* &lt;/xs:element>
aoqi@0	160	* &lt;/xs:sequence>
aoqi@0	161	* &lt;/xs:complexType>
aoqi@0	162	* </pre>
aoqi@0	163	*
aoqi@0	164	* @author <ul><li>Kohsuke Kawaguchi, Sun Microsystems, Inc.</li><li>Sekhar Vajjhala, Sun Microsystems, Inc.</li></ul>
aoqi@0	165	* @see XmlElement
aoqi@0	166	* @see XmlElementRef
aoqi@0	167	* @see XmlElementRefs
aoqi@0	168	* @see XmlJavaTypeAdapter
aoqi@0	169	* @since JAXB2.0
aoqi@0	170	*/
aoqi@0	171	@Retention(RUNTIME) @Target({FIELD,METHOD})
aoqi@0	172	public @interface XmlElements {
aoqi@0	173	/**
aoqi@0	174	* Collection of @{@link XmlElement} annotations
aoqi@0	175	*/
aoqi@0	176	XmlElement[] value();
aoqi@0	177	}