325N/A/*
325N/A * Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
325N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
325N/A *
325N/A * This code is free software; you can redistribute it and/or modify it
325N/A * under the terms of the GNU General Public License version 2 only, as
325N/A * published by the Free Software Foundation. Oracle designates this
325N/A * particular file as subject to the "Classpath" exception as provided
325N/A * by Oracle in the LICENSE file that accompanied this code.
325N/A *
325N/A * This code is distributed in the hope that it will be useful, but WITHOUT
325N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
325N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
325N/A * version 2 for more details (a copy is included in the LICENSE file that
325N/A * accompanied this code).
325N/A *
325N/A * You should have received a copy of the GNU General Public License version
325N/A * 2 along with this work; if not, write to the Free Software Foundation,
325N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
325N/A *
325N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
325N/A * or visit www.oracle.com if you need additional information or have any
325N/A * questions.
325N/A */
325N/A
325N/Apackage javax.xml.bind.annotation;
325N/A
325N/Aimport javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
325N/Aimport static java.lang.annotation.RetentionPolicy.RUNTIME;
325N/Aimport static java.lang.annotation.ElementType.FIELD;
325N/Aimport static java.lang.annotation.ElementType.METHOD;
325N/Aimport java.lang.annotation.Retention;
325N/Aimport java.lang.annotation.Target;
325N/A
325N/A/**
325N/A * <p>
325N/A * A container for multiple @{@link XmlElement} annotations.
325N/A *
325N/A * Multiple annotations of the same type are not allowed on a program
325N/A * element. This annotation therefore serves as a container annotation
325N/A * for multiple &#64;XmlElements as follows:
325N/A *
325N/A * <pre>
325N/A * &#64;XmlElements({ @XmlElement(...),@XmlElement(...) })
325N/A * </pre>
325N/A *
325N/A * <p>The <tt>@XmlElements</tt> annnotation can be used with the
325N/A * following program elements: </p>
325N/A * <ul>
325N/A * <li> a JavaBean property </li>
325N/A * <li> non static, non transient field </li>
325N/A * </ul>
325N/A *
325N/A * This annotation is intended for annotation a JavaBean collection
325N/A * property (e.g. List).
325N/A *
325N/A * <p><b>Usage</b></p>
325N/A *
325N/A * <p>The usage is subject to the following constraints:
325N/A * <ul>
325N/A * <li> This annotation can be used with the following
325N/A * annotations: @{@link XmlIDREF}, @{@link XmlElementWrapper}. </li>
325N/A * <li> If @XmlIDREF is also specified on the JavaBean property,
325N/A * then each &#64;XmlElement.type() must contain a JavaBean
325N/A * property annotated with <tt>&#64;XmlID</tt>.</li>
325N/A * </ul>
325N/A *
325N/A * <p>See "Package Specification" in javax.xml.bind.package javadoc for
325N/A * additional common information.</p>
325N/A *
325N/A * <hr>
325N/A *
325N/A * <p><b>Example 1:</b> Map to a list of elements</p>
325N/A * <pre>
325N/A *
325N/A * // Mapped code fragment
325N/A * public class Foo {
325N/A * &#64;XmlElements(
325N/A * &#64;XmlElement(name="A", type=Integer.class),
325N/A * &#64;XmlElement(name="B", type=Float.class)
325N/A * }
325N/A * public List items;
325N/A * }
325N/A *
325N/A * &lt;!-- XML Representation for a List of {1,2.5}
325N/A * XML output is not wrapped using another element -->
325N/A * ...
325N/A * &lt;A> 1 &lt;/A>
325N/A * &lt;B> 2.5 &lt;/B>
325N/A * ...
325N/A *
325N/A * &lt;!-- XML Schema fragment -->
325N/A * &lt;xs:complexType name="Foo">
325N/A * &lt;xs:sequence>
325N/A * &lt;xs:choice minOccurs="0" maxOccurs="unbounded">
325N/A * &lt;xs:element name="A" type="xs:int"/>
325N/A * &lt;xs:element name="B" type="xs:float"/>
325N/A * &lt;xs:choice>
325N/A * &lt;/xs:sequence>
325N/A * &lt;/xs:complexType>
325N/A *
325N/A * </pre>
325N/A *
325N/A * <p><b>Example 2:</b> Map to a list of elements wrapped with another element
325N/A * </p>
325N/A * <pre>
325N/A *
325N/A * // Mapped code fragment
325N/A * public class Foo {
325N/A * &#64;XmlElementWrapper(name="bar")
325N/A * &#64;XmlElements(
325N/A * &#64;XmlElement(name="A", type=Integer.class),
325N/A * &#64;XmlElement(name="B", type=Float.class)
325N/A * }
325N/A * public List items;
325N/A * }
325N/A *
325N/A * &lt;!-- XML Schema fragment -->
325N/A * &lt;xs:complexType name="Foo">
325N/A * &lt;xs:sequence>
325N/A * &lt;xs:element name="bar">
325N/A * &lt;xs:complexType>
325N/A * &lt;xs:choice minOccurs="0" maxOccurs="unbounded">
325N/A * &lt;xs:element name="A" type="xs:int"/>
325N/A * &lt;xs:element name="B" type="xs:float"/>
325N/A * &lt;/xs:choice>
325N/A * &lt;/xs:complexType>
325N/A * &lt;/xs:element>
325N/A * &lt;/xs:sequence>
325N/A * &lt;/xs:complexType>
325N/A * </pre>
325N/A *
325N/A * <p><b>Example 3:</b> Change element name based on type using an adapter.
325N/A * </p>
325N/A * <pre>
325N/A * class Foo {
325N/A * &#64;XmlJavaTypeAdapter(QtoPAdapter.class)
325N/A * &#64;XmlElements({
325N/A * &#64;XmlElement(name="A",type=PX.class),
325N/A * &#64;XmlElement(name="B",type=PY.class)
325N/A * })
325N/A * Q bar;
325N/A * }
325N/A *
325N/A * &#64;XmlType abstract class P {...}
325N/A * &#64;XmlType(name="PX") class PX extends P {...}
325N/A * &#64;XmlType(name="PY") class PY extends P {...}
325N/A *
325N/A * &lt;!-- XML Schema fragment -->
325N/A * &lt;xs:complexType name="Foo">
325N/A * &lt;xs:sequence>
325N/A * &lt;xs:element name="bar">
325N/A * &lt;xs:complexType>
325N/A * &lt;xs:choice minOccurs="0" maxOccurs="unbounded">
325N/A * &lt;xs:element name="A" type="PX"/>
325N/A * &lt;xs:element name="B" type="PY"/>
325N/A * &lt;/xs:choice>
325N/A * &lt;/xs:complexType>
325N/A * &lt;/xs:element>
325N/A * &lt;/xs:sequence>
325N/A * &lt;/xs:complexType>
325N/A * </pre>
325N/A *
325N/A * @author <ul><li>Kohsuke Kawaguchi, Sun Microsystems, Inc.</li><li>Sekhar Vajjhala, Sun Microsystems, Inc.</li></ul>
325N/A * @see XmlElement
325N/A * @see XmlElementRef
325N/A * @see XmlElementRefs
325N/A * @see XmlJavaTypeAdapter
325N/A * @since JAXB2.0
325N/A */
325N/A@Retention(RUNTIME) @Target({FIELD,METHOD})
325N/Apublic @interface XmlElements {
325N/A /**
325N/A * Collection of @{@link XmlElement} annotations
325N/A */
325N/A XmlElement[] value();
325N/A}