javax.xml.bind.annotation.XmlElements Maven / Gradle / Ivy

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2004-2017 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://oss.oracle.com/licenses/CDDL+GPL-1.1
 * or LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

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: 
 * 
 *    a JavaBean property 
 *    non static, non transient field 
 * 
 *
 * This annotation is intended for annotation a JavaBean collection
 * property (e.g. List). 
 *
 * Usage
 *
 * The usage is subject to the following constraints:
 * 

 *    This annotation can be used with the following
 *        annotations: @{@link XmlIDREF}, @{@link XmlElementWrapper}. 
 *    If @XmlIDREF is also specified on the JavaBean property,
 *        then each @XmlElement.type() must contain a JavaBean
 *        property annotated with {@code @XmlID}.
 * 
 *
 * 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 Kohsuke Kawaguchi, Sun Microsystems, Inc.
Sekhar Vajjhala, Sun Microsystems, Inc.
 * @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();
}