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