ohair@286: /* ohair@286: * Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved. ohair@286: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. ohair@286: * ohair@286: * This code is free software; you can redistribute it and/or modify it ohair@286: * under the terms of the GNU General Public License version 2 only, as ohair@286: * published by the Free Software Foundation. Oracle designates this ohair@286: * particular file as subject to the "Classpath" exception as provided ohair@286: * by Oracle in the LICENSE file that accompanied this code. ohair@286: * ohair@286: * This code is distributed in the hope that it will be useful, but WITHOUT ohair@286: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or ohair@286: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License ohair@286: * version 2 for more details (a copy is included in the LICENSE file that ohair@286: * accompanied this code). ohair@286: * ohair@286: * You should have received a copy of the GNU General Public License version ohair@286: * 2 along with this work; if not, write to the Free Software Foundation, ohair@286: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. ohair@286: * ohair@286: * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA ohair@286: * or visit www.oracle.com if you need additional information or have any ohair@286: * questions. ohair@286: */ ohair@286: ohair@286: package javax.xml.bind.annotation; ohair@286: ohair@286: import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter; ohair@286: import static java.lang.annotation.RetentionPolicy.RUNTIME; ohair@286: import static java.lang.annotation.ElementType.FIELD; ohair@286: import static java.lang.annotation.ElementType.METHOD; ohair@286: import java.lang.annotation.Retention; ohair@286: import java.lang.annotation.Target; ohair@286: ohair@286: /** ohair@286: *

ohair@286: * A container for multiple @{@link XmlElement} annotations. ohair@286: * ohair@286: * Multiple annotations of the same type are not allowed on a program ohair@286: * element. This annotation therefore serves as a container annotation ohair@286: * for multiple @XmlElements as follows: ohair@286: * ohair@286: * 

ohair@286:  * @XmlElements({ @XmlElement(...),@XmlElement(...) })
ohair@286:  *
ohair@286: * ohair@286: *

The @XmlElements annnotation can be used with the ohair@286: * following program elements:

ohair@286: * ohair@286: * ohair@286: * This annotation is intended for annotation a JavaBean collection ohair@286: * property (e.g. List). ohair@286: * ohair@286: *

Usage

ohair@286: * ohair@286: *

The usage is subject to the following constraints: ohair@286: *

ohair@286: * ohair@286: *

See "Package Specification" in javax.xml.bind.package javadoc for ohair@286: * additional common information.

ohair@286: * ohair@286: *
ohair@286: * ohair@286: *

Example 1: Map to a list of elements

ohair@286: * 
ohair@286:  *
ohair@286:  *    // Mapped code fragment
ohair@286:  *    public class Foo {
ohair@286:  *        @XmlElements(
ohair@286:  *            @XmlElement(name="A", type=Integer.class),
ohair@286:  *            @XmlElement(name="B", type=Float.class)
ohair@286:  *         }
ohair@286:  *         public List items;
ohair@286:  *    }
ohair@286:  *
ohair@286:  *    <!-- XML Representation for a List of {1,2.5}
ohair@286:  *            XML output is not wrapped using another element -->
ohair@286:  *    ...
ohair@286:  *    <A> 1 </A>
ohair@286:  *    <B> 2.5 </B>
ohair@286:  *    ...
ohair@286:  *
ohair@286:  *    <!-- XML Schema fragment -->
ohair@286:  *    <xs:complexType name="Foo">
ohair@286:  *      <xs:sequence>
ohair@286:  *        <xs:choice minOccurs="0" maxOccurs="unbounded">
ohair@286:  *          <xs:element name="A" type="xs:int"/>
ohair@286:  *          <xs:element name="B" type="xs:float"/>
ohair@286:  *        <xs:choice>
ohair@286:  *      </xs:sequence>
ohair@286:  *    </xs:complexType>
ohair@286:  *
ohair@286:  *
ohair@286: * ohair@286: *

Example 2: Map to a list of elements wrapped with another element ohair@286: *

ohair@286: * 
ohair@286:  *
ohair@286:  *    // Mapped code fragment
ohair@286:  *    public class Foo {
ohair@286:  *        @XmlElementWrapper(name="bar")
ohair@286:  *        @XmlElements(
ohair@286:  *            @XmlElement(name="A", type=Integer.class),
ohair@286:  *            @XmlElement(name="B", type=Float.class)
ohair@286:  *        }
ohair@286:  *        public List items;
ohair@286:  *    }
ohair@286:  *
ohair@286:  *    <!-- XML Schema fragment -->
ohair@286:  *    <xs:complexType name="Foo">
ohair@286:  *      <xs:sequence>
ohair@286:  *        <xs:element name="bar">
ohair@286:  *          <xs:complexType>
ohair@286:  *            <xs:choice minOccurs="0" maxOccurs="unbounded">
ohair@286:  *              <xs:element name="A" type="xs:int"/>
ohair@286:  *              <xs:element name="B" type="xs:float"/>
ohair@286:  *            </xs:choice>
ohair@286:  *          </xs:complexType>
ohair@286:  *        </xs:element>
ohair@286:  *      </xs:sequence>
ohair@286:  *    </xs:complexType>
ohair@286:  *
ohair@286: * ohair@286: *

Example 3: Change element name based on type using an adapter. ohair@286: *

ohair@286: * 
ohair@286:  *    class Foo {
ohair@286:  *       @XmlJavaTypeAdapter(QtoPAdapter.class)
ohair@286:  *       @XmlElements({
ohair@286:  *           @XmlElement(name="A",type=PX.class),
ohair@286:  *           @XmlElement(name="B",type=PY.class)
ohair@286:  *       })
ohair@286:  *       Q bar;
ohair@286:  *    }
ohair@286:  *
ohair@286:  *    @XmlType abstract class P {...}
ohair@286:  *    @XmlType(name="PX") class PX extends P {...}
ohair@286:  *    @XmlType(name="PY") class PY extends P {...}
ohair@286:  *
ohair@286:  *    <!-- XML Schema fragment -->
ohair@286:  *    <xs:complexType name="Foo">
ohair@286:  *      <xs:sequence>
ohair@286:  *        <xs:element name="bar">
ohair@286:  *          <xs:complexType>
ohair@286:  *            <xs:choice minOccurs="0" maxOccurs="unbounded">
ohair@286:  *              <xs:element name="A" type="PX"/>
ohair@286:  *              <xs:element name="B" type="PY"/>
ohair@286:  *            </xs:choice>
ohair@286:  *          </xs:complexType>
ohair@286:  *        </xs:element>
ohair@286:  *      </xs:sequence>
ohair@286:  *    </xs:complexType>
ohair@286:  *
ohair@286: * ohair@286: * @author ohair@286: * @see XmlElement ohair@286: * @see XmlElementRef ohair@286: * @see XmlElementRefs ohair@286: * @see XmlJavaTypeAdapter ohair@286: * @since JAXB2.0 ohair@286: */ ohair@286: @Retention(RUNTIME) @Target({FIELD,METHOD}) ohair@286: public @interface XmlElements { ohair@286: /** ohair@286: * Collection of @{@link XmlElement} annotations ohair@286: */ ohair@286: XmlElement[] value(); ohair@286: }