All Downloads are FREE. Search and download functionalities are using the official Maven repository.

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

There is a newer version: 4.0.3
Show newest version
/*
 * Copyright (c) 2004, 2018 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Distribution License v. 1.0, which is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */

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(); }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy