Tue, 09 Apr 2013 14:51:13 +0100
8010393: Update JAX-WS RI to 2.2.9-b12941
Reviewed-by: alanb, erikj
Contributed-by: miroslav.kos@oracle.com, martin.grebac@oracle.com
ohair@286 | 1 | /* |
ohair@286 | 2 | * Copyright (c) 2005, 2011, Oracle and/or its affiliates. All rights reserved. |
ohair@286 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
ohair@286 | 4 | * |
ohair@286 | 5 | * This code is free software; you can redistribute it and/or modify it |
ohair@286 | 6 | * under the terms of the GNU General Public License version 2 only, as |
ohair@286 | 7 | * published by the Free Software Foundation. Oracle designates this |
ohair@286 | 8 | * particular file as subject to the "Classpath" exception as provided |
ohair@286 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
ohair@286 | 10 | * |
ohair@286 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
ohair@286 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
ohair@286 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
ohair@286 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
ohair@286 | 15 | * accompanied this code). |
ohair@286 | 16 | * |
ohair@286 | 17 | * You should have received a copy of the GNU General Public License version |
ohair@286 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
ohair@286 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
ohair@286 | 20 | * |
ohair@286 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
ohair@286 | 22 | * or visit www.oracle.com if you need additional information or have any |
ohair@286 | 23 | * questions. |
ohair@286 | 24 | */ |
ohair@286 | 25 | |
ohair@286 | 26 | package javax.xml.bind.annotation; |
ohair@286 | 27 | |
ohair@286 | 28 | import java.lang.annotation.Retention; |
ohair@286 | 29 | import java.lang.annotation.Target; |
ohair@286 | 30 | import static java.lang.annotation.RetentionPolicy.RUNTIME; |
ohair@286 | 31 | import static java.lang.annotation.ElementType.FIELD; |
ohair@286 | 32 | import static java.lang.annotation.ElementType.METHOD; |
ohair@286 | 33 | import static java.lang.annotation.ElementType.PARAMETER; |
ohair@286 | 34 | |
ohair@286 | 35 | /** |
ohair@286 | 36 | * Used to map a property to a list simple type. |
ohair@286 | 37 | * |
ohair@286 | 38 | * <p><b>Usage</b> </p> |
ohair@286 | 39 | * <p> |
ohair@286 | 40 | * The <tt>@XmlList</tt> annotation can be used with the |
ohair@286 | 41 | * following program elements: |
ohair@286 | 42 | * <ul> |
ohair@286 | 43 | * <li> JavaBean property </li> |
ohair@286 | 44 | * <li> field </li> |
ohair@286 | 45 | * </ul> |
ohair@286 | 46 | * |
ohair@286 | 47 | * <p> |
ohair@286 | 48 | * When a collection property is annotated just with @XmlElement, |
ohair@286 | 49 | * each item in the collection will be wrapped by an element. |
ohair@286 | 50 | * For example, |
ohair@286 | 51 | * |
ohair@286 | 52 | * <pre> |
ohair@286 | 53 | * @XmlRootElement |
ohair@286 | 54 | * class Foo { |
ohair@286 | 55 | * @XmlElement |
ohair@286 | 56 | * List<String> data; |
ohair@286 | 57 | * } |
ohair@286 | 58 | * </pre> |
ohair@286 | 59 | * |
ohair@286 | 60 | * would produce XML like this: |
ohair@286 | 61 | * |
ohair@286 | 62 | * <pre> |
ohair@286 | 63 | * <foo> |
ohair@286 | 64 | * <data>abc</data> |
ohair@286 | 65 | * <data>def</data> |
ohair@286 | 66 | * </foo> |
ohair@286 | 67 | * </pre> |
ohair@286 | 68 | * |
ohair@286 | 69 | * @XmlList annotation, on the other hand, allows multiple values to be |
ohair@286 | 70 | * represented as whitespace-separated tokens in a single element. For example, |
ohair@286 | 71 | * |
ohair@286 | 72 | * <pre> |
ohair@286 | 73 | * @XmlRootElement |
ohair@286 | 74 | * class Foo { |
ohair@286 | 75 | * @XmlElement |
ohair@286 | 76 | * @XmlList |
ohair@286 | 77 | * List<String> data; |
ohair@286 | 78 | * } |
ohair@286 | 79 | * </pre> |
ohair@286 | 80 | * |
ohair@286 | 81 | * the above code will produce XML like this: |
ohair@286 | 82 | * |
ohair@286 | 83 | * <pre> |
ohair@286 | 84 | * <foo> |
ohair@286 | 85 | * <data>abc def</data> |
ohair@286 | 86 | * </foo> |
ohair@286 | 87 | * </pre> |
ohair@286 | 88 | * |
ohair@286 | 89 | * <p>This annotation can be used with the following annotations: |
ohair@286 | 90 | * {@link XmlElement}, |
ohair@286 | 91 | * {@link XmlAttribute}, |
ohair@286 | 92 | * {@link XmlValue}, |
ohair@286 | 93 | * {@link XmlIDREF}. |
ohair@286 | 94 | * <ul> |
ohair@286 | 95 | * <li> The use of <tt>@XmlList</tt> with {@link XmlValue} while |
ohair@286 | 96 | * allowed, is redundant since {@link XmlList} maps a |
ohair@286 | 97 | * collection type to a simple schema type that derives by |
ohair@286 | 98 | * list just as {@link XmlValue} would. </li> |
ohair@286 | 99 | * |
ohair@286 | 100 | * <li> The use of <tt>@XmlList</tt> with {@link XmlAttribute} while |
ohair@286 | 101 | * allowed, is redundant since {@link XmlList} maps a |
ohair@286 | 102 | * collection type to a simple schema type that derives by |
ohair@286 | 103 | * list just as {@link XmlAttribute} would. </li> |
ohair@286 | 104 | * </ul> |
ohair@286 | 105 | * |
ohair@286 | 106 | * @author <ul><li>Kohsuke Kawaguchi, Sun Microsystems, Inc.</li><li>Sekhar Vajjhala, Sun Microsystems, Inc.</li></ul> |
ohair@286 | 107 | * @since JAXB2.0 |
ohair@286 | 108 | */ |
ohair@286 | 109 | @Retention(RUNTIME) @Target({FIELD,METHOD,PARAMETER}) |
ohair@286 | 110 | public @interface XmlList { |
ohair@286 | 111 | } |