Mercurial > jdk8-mips64-public > jaxws / annotate
src/share/jaxws_classes/javax/xml/bind/annotation/XmlElementWrapper.java@9c07ef4934dd (annotated)
src/share/jaxws_classes/javax/xml/bind/annotation/XmlElementWrapper.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 javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter; |
| aoqi@0 | 29 | import static java.lang.annotation.RetentionPolicy.RUNTIME; |
| aoqi@0 | 30 | import static java.lang.annotation.ElementType.FIELD; |
| aoqi@0 | 31 | import static java.lang.annotation.ElementType.METHOD; |
| aoqi@0 | 32 | import java.lang.annotation.Retention; |
| aoqi@0 | 33 | import java.lang.annotation.Target; |
| aoqi@0 | 34 | |
| aoqi@0 | 35 | /** |
| aoqi@0 | 36 | * Generates a wrapper element around XML representation. |
| aoqi@0 | 37 | * |
| aoqi@0 | 38 | * This is primarily intended to be used to produce a wrapper |
| aoqi@0 | 39 | * XML element around collections. The annotation therefore supports |
| aoqi@0 | 40 | * two forms of serialization shown below. |
| aoqi@0 | 41 | * |
| aoqi@0 | 42 | * <pre> |
| aoqi@0 | 43 | * //Example: code fragment |
| aoqi@0 | 44 | * int[] names; |
| aoqi@0 | 45 | * |
| aoqi@0 | 46 | * // XML Serialization Form 1 (Unwrapped collection) |
| aoqi@0 | 47 | * <names> ... </names> |
| aoqi@0 | 48 | * <names> ... </names> |
| aoqi@0 | 49 | * |
| aoqi@0 | 50 | * // XML Serialization Form 2 ( Wrapped collection ) |
| aoqi@0 | 51 | * <wrapperElement> |
| aoqi@0 | 52 | * <names> value-of-item </names> |
| aoqi@0 | 53 | * <names> value-of-item </names> |
| aoqi@0 | 54 | * .... |
| aoqi@0 | 55 | * </wrapperElement> |
| aoqi@0 | 56 | * </pre> |
| aoqi@0 | 57 | * |
| aoqi@0 | 58 | * <p> The two serialized XML forms allow a null collection to be |
| aoqi@0 | 59 | * represented either by absence or presence of an element with a |
| aoqi@0 | 60 | * nillable attribute. |
| aoqi@0 | 61 | * |
| aoqi@0 | 62 | * <p> <b>Usage</b> </p> |
| aoqi@0 | 63 | * <p> |
| aoqi@0 | 64 | * The <tt>@XmlElementWrapper</tt> annotation can be used with the |
| aoqi@0 | 65 | * following program elements: |
| aoqi@0 | 66 | * <ul> |
| aoqi@0 | 67 | * <li> JavaBean property </li> |
| aoqi@0 | 68 | * <li> non static, non transient field </li> |
| aoqi@0 | 69 | * </ul> |
| aoqi@0 | 70 | * |
| aoqi@0 | 71 | * <p>The usage is subject to the following constraints: |
| aoqi@0 | 72 | * <ul> |
| aoqi@0 | 73 | * <li> The property must be a collection property </li> |
| aoqi@0 | 74 | * <li> This annotation can be used with the following annotations: |
| aoqi@0 | 75 | * {@link XmlElement}, |
| aoqi@0 | 76 | * {@link XmlElements}, |
| aoqi@0 | 77 | * {@link XmlElementRef}, |
| aoqi@0 | 78 | * {@link XmlElementRefs}, |
| aoqi@0 | 79 | * {@link XmlJavaTypeAdapter}.</li> |
| aoqi@0 | 80 | * </ul> |
| aoqi@0 | 81 | * |
| aoqi@0 | 82 | * <p>See "Package Specification" in javax.xml.bind.package javadoc for |
| aoqi@0 | 83 | * additional common information.</p> |
| aoqi@0 | 84 | * |
| aoqi@0 | 85 | * @author <ul><li>Kohsuke Kawaguchi, Sun Microsystems, Inc.</li><li>Sekhar Vajjhala, Sun Microsystems, Inc.</li></ul> |
| aoqi@0 | 86 | * @see XmlElement |
| aoqi@0 | 87 | * @see XmlElements |
| aoqi@0 | 88 | * @see XmlElementRef |
| aoqi@0 | 89 | * @see XmlElementRefs |
| aoqi@0 | 90 | * @since JAXB2.0 |
| aoqi@0 | 91 | * |
| aoqi@0 | 92 | */ |
| aoqi@0 | 93 | |
| aoqi@0 | 94 | @Retention(RUNTIME) @Target({FIELD, METHOD}) |
| aoqi@0 | 95 | public @interface XmlElementWrapper { |
| aoqi@0 | 96 | /** |
| aoqi@0 | 97 | * Name of the XML wrapper element. By default, the XML wrapper |
| aoqi@0 | 98 | * element name is derived from the JavaBean property name. |
| aoqi@0 | 99 | */ |
| aoqi@0 | 100 | String name() default "##default"; |
| aoqi@0 | 101 | |
| aoqi@0 | 102 | /** |
| aoqi@0 | 103 | * XML target namespace of the XML wrapper element. |
| aoqi@0 | 104 | * <p> |
| aoqi@0 | 105 | * If the value is "##default", then the namespace is determined |
| aoqi@0 | 106 | * as follows: |
| aoqi@0 | 107 | * <ol> |
| aoqi@0 | 108 | * <li> |
| aoqi@0 | 109 | * If the enclosing package has {@link XmlSchema} annotation, |
| aoqi@0 | 110 | * and its {@link XmlSchema#elementFormDefault() elementFormDefault} |
| aoqi@0 | 111 | * is {@link XmlNsForm#QUALIFIED QUALIFIED}, then the namespace of |
| aoqi@0 | 112 | * the enclosing class. |
| aoqi@0 | 113 | * |
| aoqi@0 | 114 | * <li> |
| aoqi@0 | 115 | * Otherwise "" (which produces unqualified element in the default |
| aoqi@0 | 116 | * namespace. |
| aoqi@0 | 117 | * </ol> |
| aoqi@0 | 118 | */ |
| aoqi@0 | 119 | String namespace() default "##default"; |
| aoqi@0 | 120 | |
| aoqi@0 | 121 | /** |
| aoqi@0 | 122 | * If true, the absence of the collection is represented by |
| aoqi@0 | 123 | * using <tt>xsi:nil='true'</tt>. Otherwise, it is represented by |
| aoqi@0 | 124 | * the absence of the element. |
| aoqi@0 | 125 | */ |
| aoqi@0 | 126 | boolean nillable() default false; |
| aoqi@0 | 127 | |
| aoqi@0 | 128 | /** |
| aoqi@0 | 129 | * Customize the wrapper element declaration to be required. |
| aoqi@0 | 130 | * |
| aoqi@0 | 131 | * <p> |
| aoqi@0 | 132 | * If required() is true, then the corresponding generated |
| aoqi@0 | 133 | * XML schema element declaration will have <tt>minOccurs="1"</tt>, |
| aoqi@0 | 134 | * to indicate that the wrapper element is always expected. |
| aoqi@0 | 135 | * |
| aoqi@0 | 136 | * <p> |
| aoqi@0 | 137 | * Note that this only affects the schema generation, and |
| aoqi@0 | 138 | * not the unmarshalling or marshalling capability. This is |
| aoqi@0 | 139 | * simply a mechanism to let users express their application constraints |
| aoqi@0 | 140 | * better. |
| aoqi@0 | 141 | * |
| aoqi@0 | 142 | * @since JAXB 2.1 |
| aoqi@0 | 143 | */ |
| aoqi@0 | 144 | boolean required() default false; |
| aoqi@0 | 145 | } |
