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

* 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: * * 

 * @XmlElements({ @XmlElement(...),@XmlElement(...) })
 *
* *

The {@code @XmlElements} annotation can be used with the * following program elements:

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

Usage

* *

The usage is subject to the following constraints: *

* *

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

* *
* *

Example 1: Map to a list of elements

* 
 *
 *    // Mapped code fragment
 *    public class Foo {
 *        @XmlElements(
 *            @XmlElement(name="A", type=Integer.class),
 *            @XmlElement(name="B", type=Float.class)
 *         )
 *         public List items;
 *    }
 * {@code
 *
 *    
 *    ...
 *     1 
 *     2.5 
 *    ...
 *
 *    
 *    
 *      
 *        
 *          
 *          
 *        
 *      
 *    
 *
 * }
* *

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

* 
 *
 *    // 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;
 *    }
 * {@code
 *
 *    
 *    
 *      
 *        
 *          
 *            
 *              
 *              
 *            
 *          
 *        
 *      
 *    
 * }
* *

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

* 
 *    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 {...}
 * {@code
 *
 *    
 *    
 *      
 *        
 *          
 *            
 *              
 *              
 *            
 *          
 *        
 *      
 *    
 * }
* * @author * @see XmlElement * @see XmlElementRef * @see XmlElementRefs * @see XmlJavaTypeAdapter * @since 1.6, JAXB 2.0 */ @Retention(RUNTIME) @Target({FIELD,METHOD}) public @interface XmlElements { /** * Collection of @{@link XmlElement} annotations */ XmlElement[] value(); }