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