Mercurial > jdk8-mips64-public > jaxws / annotate

src/share/jaxws_classes/javax/xml/bind/annotation/XmlRootElement.java@9c07ef4934dd (annotated)

src/share/jaxws_classes/javax/xml/bind/annotation/XmlRootElement.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) 2004, 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
aoqi@0 31 import static java.lang.annotation.RetentionPolicy.RUNTIME;
aoqi@0 32 import static java.lang.annotation.ElementType.TYPE;
aoqi@0 33
aoqi@0 34 /**
aoqi@0 35 * Maps a class or an enum type to an XML element.
aoqi@0 36 *
aoqi@0 37 * <p> <b>Usage</b> </p>
aoqi@0 38 * <p>
aoqi@0 39 * The &#64;XmlRootElement annotation can be used with the following program
aoqi@0 40 * elements:
aoqi@0 41 * <ul>
aoqi@0 42 * <li> a top level class </li>
aoqi@0 43 * <li> an enum type </li>
aoqi@0 44 * </ul>
aoqi@0 45 *
aoqi@0 46 * <p>See "Package Specification" in javax.xml.bind.package javadoc for
aoqi@0 47 * additional common information.</p>
aoqi@0 48 *
aoqi@0 49 * <p>
aoqi@0 50 * When a top level class or an enum type is annotated with the
aoqi@0 51 * &#64;XmlRootElement annotation, then its value is represented
aoqi@0 52 * as XML element in an XML document.
aoqi@0 53 *
aoqi@0 54 * <p> This annotation can be used with the following annotations:
aoqi@0 55 * {@link XmlType}, {@link XmlEnum}, {@link XmlAccessorType},
aoqi@0 56 * {@link XmlAccessorOrder}.
aoqi@0 57 * <p>
aoqi@0 58
aoqi@0 59 * <p>
aoqi@0 60 * <b>Example 1: </b> Associate an element with XML Schema type
aoqi@0 61 * <pre>
aoqi@0 62 * // Example: Code fragment
aoqi@0 63 * &#64;XmlRootElement
aoqi@0 64 * class Point {
aoqi@0 65 * int x;
aoqi@0 66 * int y;
aoqi@0 67 * Point(int _x,int _y) {x=_x;y=_y;}
aoqi@0 68 * }
aoqi@0 69 * </pre>
aoqi@0 70 *
aoqi@0 71 * <pre>
aoqi@0 72 * //Example: Code fragment corresponding to XML output
aoqi@0 73 * marshal( new Point(3,5), System.out);
aoqi@0 74 * </pre>
aoqi@0 75 *
aoqi@0 76 * <pre>
aoqi@0 77 * &lt;!-- Example: XML output -->
aoqi@0 78 * &lt;point>
aoqi@0 79 * &lt;x> 3 </x>
aoqi@0 80 * &lt;y> 5 </y>
aoqi@0 81 * &lt;/point>
aoqi@0 82 * </pre>
aoqi@0 83 *
aoqi@0 84 * The annotation causes an global element declaration to be produced
aoqi@0 85 * in the schema. The global element declaration is associated with
aoqi@0 86 * the XML schema type to which the class is mapped.
aoqi@0 87 *
aoqi@0 88 * <pre>
aoqi@0 89 * &lt;!-- Example: XML schema definition -->
aoqi@0 90 * &lt;xs:element name="point" type="point"/>
aoqi@0 91 * &lt;xs:complexType name="point">
aoqi@0 92 * &lt;xs:sequence>
aoqi@0 93 * &lt;xs:element name="x" type="xs:int"/>
aoqi@0 94 * &lt;xs:element name="y" type="xs:int"/>
aoqi@0 95 * &lt;/xs:sequence>
aoqi@0 96 * &lt;/xs:complexType>
aoqi@0 97 * </pre>
aoqi@0 98 *
aoqi@0 99 * <p>
aoqi@0 100 *
aoqi@0 101 * <b>Example 2: Orthogonality to type inheritance </b>
aoqi@0 102 *
aoqi@0 103 * <p>
aoqi@0 104 * An element declaration annotated on a type is not inherited by its
aoqi@0 105 * derived types. The following example shows this.
aoqi@0 106 * <pre>
aoqi@0 107 * // Example: Code fragment
aoqi@0 108 * &#64;XmlRootElement
aoqi@0 109 * class Point3D extends Point {
aoqi@0 110 * int z;
aoqi@0 111 * Point3D(int _x,int _y,int _z) {super(_x,_y);z=_z;}
aoqi@0 112 * }
aoqi@0 113 *
aoqi@0 114 * //Example: Code fragment corresponding to XML output *
aoqi@0 115 * marshal( new Point3D(3,5,0), System.out );
aoqi@0 116 *
aoqi@0 117 * &lt;!-- Example: XML output -->
aoqi@0 118 * &lt;!-- The element name is point3D not point -->
aoqi@0 119 * &lt;point3D>
aoqi@0 120 * &lt;x>3&lt;/x>
aoqi@0 121 * &lt;y>5&lt;/y>
aoqi@0 122 * &lt;z>0&lt;/z>
aoqi@0 123 * &lt;/point3D>
aoqi@0 124 *
aoqi@0 125 * &lt;!-- Example: XML schema definition -->
aoqi@0 126 * &lt;xs:element name="point3D" type="point3D"/>
aoqi@0 127 * &lt;xs:complexType name="point3D">
aoqi@0 128 * &lt;xs:complexContent>
aoqi@0 129 * &lt;xs:extension base="point">
aoqi@0 130 * &lt;xs:sequence>
aoqi@0 131 * &lt;xs:element name="z" type="xs:int"/>
aoqi@0 132 * &lt;/xs:sequence>
aoqi@0 133 * &lt;/xs:extension>
aoqi@0 134 * &lt;/xs:complexContent>
aoqi@0 135 * &lt;/xs:complexType>
aoqi@0 136 * </pre>
aoqi@0 137 *
aoqi@0 138 * <b>Example 3: </b> Associate a global element with XML Schema type
aoqi@0 139 * to which the class is mapped.
aoqi@0 140 * <pre>
aoqi@0 141 * //Example: Code fragment
aoqi@0 142 * &#64;XmlRootElement(name="PriceElement")
aoqi@0 143 * public class USPrice {
aoqi@0 144 * &#64;XmlElement
aoqi@0 145 * public java.math.BigDecimal price;
aoqi@0 146 * }
aoqi@0 147 *
aoqi@0 148 * &lt;!-- Example: XML schema definition -->
aoqi@0 149 * &lt;xs:element name="PriceElement" type="USPrice"/>
aoqi@0 150 * &lt;xs:complexType name="USPrice">
aoqi@0 151 * &lt;xs:sequence>
aoqi@0 152 * &lt;xs:element name="price" type="xs:decimal"/>
aoqi@0 153 * &lt;/sequence>
aoqi@0 154 * &lt;/xs:complexType>
aoqi@0 155 * </pre>
aoqi@0 156 *
aoqi@0 157 * @author Sekhar Vajjhala, Sun Microsystems, Inc.
aoqi@0 158 * @since JAXB2.0
aoqi@0 159 */
aoqi@0 160 @Retention(RUNTIME)
aoqi@0 161 @Target({TYPE})
aoqi@0 162 public @interface XmlRootElement {
aoqi@0 163 /**
aoqi@0 164 * namespace name of the XML element.
aoqi@0 165 * <p>
aoqi@0 166 * If the value is "##default", then the XML namespace name is derived
aoqi@0 167 * from the package of the class ( {@link XmlSchema} ). If the
aoqi@0 168 * package is unnamed, then the XML namespace is the default empty
aoqi@0 169 * namespace.
aoqi@0 170 */
aoqi@0 171 String namespace() default "##default";
aoqi@0 172
aoqi@0 173 /**
aoqi@0 174 * local name of the XML element.
aoqi@0 175 * <p>
aoqi@0 176 * If the value is "##default", then the name is derived from the
aoqi@0 177 * class name.
aoqi@0 178 *
aoqi@0 179 */
aoqi@0 180 String name() default "##default";
aoqi@0 181
aoqi@0 182 }

Mercurial Repository: jdk8-mips64-public/jaxws

mercurial