ohair@286: /*
ohair@286:  * Copyright (c) 2005, 2011, 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 java.lang.annotation.Retention;
ohair@286: import java.lang.annotation.Target;
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 static java.lang.annotation.ElementType.PARAMETER;
ohair@286: 
ohair@286: /**
ohair@286:  * Used to map a property to a list simple type.
ohair@286:  *
ohair@286:  * <p><b>Usage</b> </p>
ohair@286:  * <p>
ohair@286:  * The <tt>@XmlList</tt> annotation can be used with the
ohair@286:  * following program elements:
ohair@286:  * <ul>
ohair@286:  *   <li> JavaBean property </li>
ohair@286:  *   <li> field </li>
ohair@286:  * </ul>
ohair@286:  *
ohair@286:  * <p>
ohair@286:  * When a collection property is annotated just with @XmlElement,
ohair@286:  * each item in the collection will be wrapped by an element.
ohair@286:  * For example,
ohair@286:  *
ohair@286:  * <pre>
ohair@286:  * &#64;XmlRootElement
ohair@286:  * class Foo {
ohair@286:  *     &#64;XmlElement
ohair@286:  *     List&lt;String> data;
ohair@286:  * }
ohair@286:  * </pre>
ohair@286:  *
ohair@286:  * would produce XML like this:
ohair@286:  *
ohair@286:  * <pre>
ohair@286:  * &lt;foo>
ohair@286:  *   &lt;data>abc</data>
ohair@286:  *   &lt;data>def</data>
ohair@286:  * &lt;/foo>
ohair@286:  * </pre>
ohair@286:  *
ohair@286:  * &#64;XmlList annotation, on the other hand, allows multiple values to be
ohair@286:  * represented as whitespace-separated tokens in a single element. For example,
ohair@286:  *
ohair@286:  * <pre>
ohair@286:  * &#64;XmlRootElement
ohair@286:  * class Foo {
ohair@286:  *     &#64;XmlElement
ohair@286:  *     &#64;XmlList
ohair@286:  *     List&lt;String> data;
ohair@286:  * }
ohair@286:  * </pre>
ohair@286:  *
ohair@286:  * the above code will produce XML like this:
ohair@286:  *
ohair@286:  * <pre>
ohair@286:  * &lt;foo>
ohair@286:  *   &lt;data>abc def</data>
ohair@286:  * &lt;/foo>
ohair@286:  * </pre>
ohair@286:  *
ohair@286:  * <p>This annotation can be used with the following annotations:
ohair@286:  *        {@link XmlElement},
ohair@286:  *        {@link XmlAttribute},
ohair@286:  *        {@link XmlValue},
ohair@286:  *        {@link XmlIDREF}.
ohair@286:  *  <ul>
ohair@286:  *    <li> The use of <tt>@XmlList</tt> with {@link XmlValue} while
ohair@286:  *         allowed, is redundant since  {@link XmlList} maps a
ohair@286:  *         collection type to a simple schema type that derives by
ohair@286:  *         list just as {@link XmlValue} would. </li>
ohair@286:  *
ohair@286:  *    <li> The use of <tt>@XmlList</tt> with {@link XmlAttribute} while
ohair@286:  *         allowed, is redundant since  {@link XmlList} maps a
ohair@286:  *         collection type to a simple schema type that derives by
ohair@286:  *         list just as {@link XmlAttribute} would. </li>
ohair@286:  *  </ul>
ohair@286:  *
ohair@286:  * @author <ul><li>Kohsuke Kawaguchi, Sun Microsystems, Inc.</li><li>Sekhar Vajjhala, Sun Microsystems, Inc.</li></ul>
ohair@286:  * @since JAXB2.0
ohair@286:  */
ohair@286: @Retention(RUNTIME) @Target({FIELD,METHOD,PARAMETER})
ohair@286: public @interface XmlList {
ohair@286: }