1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/src/share/jaxws_classes/javax/xml/bind/annotation/package.html Wed Apr 27 01:27:09 2016 +0800
1.3 @@ -0,0 +1,286 @@
1.4 +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
1.5 +<!--
1.6 + Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved.
1.7 + DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
1.8 +
1.9 + This code is free software; you can redistribute it and/or modify it
1.10 + under the terms of the GNU General Public License version 2 only, as
1.11 + published by the Free Software Foundation. Oracle designates this
1.12 + particular file as subject to the "Classpath" exception as provided
1.13 + by Oracle in the LICENSE file that accompanied this code.
1.14 +
1.15 + This code is distributed in the hope that it will be useful, but WITHOUT
1.16 + ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
1.17 + FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
1.18 + version 2 for more details (a copy is included in the LICENSE file that
1.19 + accompanied this code).
1.20 +
1.21 + You should have received a copy of the GNU General Public License version
1.22 + 2 along with this work; if not, write to the Free Software Foundation,
1.23 + Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
1.24 +
1.25 + Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
1.26 + or visit www.oracle.com if you need additional information or have any
1.27 + questions.
1.28 +-->
1.29 +
1.30 +<html>
1.31 + <head>
1.32 +
1.33 +
1.34 + </head>
1.35 +
1.36 + <body bgcolor="white">
1.37 +
1.38 + <p>
1.39 + Defines annotations for customizing Java program elements to XML Schema mapping.
1.40 +
1.41 + <h2>Package Specification</h2>
1.42 + <p>The following table shows the JAXB mapping annotations
1.43 + that can be associated with each program element. </p>
1.44 +
1.45 + <table border="1" cellpadding="4" cellspacing="3">
1.46 + <tbody>
1.47 + <tr>
1.48 + <td><b>Program Element</b></td>
1.49 + <td><b>JAXB annotation</b></td>
1.50 + </tr>
1.51 + <tr valign="top">
1.52 + <td><b>Package</b></td>
1.53 + <td>
1.54 + <table>
1.55 + <tr valign="top">
1.56 + <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlAccessorOrder.html">XmlAccessorOrder</a></b></td>
1.57 + </tr>
1.58 + <tr valign="top">
1.59 + <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlAccessorType.html">XmlAccessorType</a></b></td>
1.60 + </tr>
1.61 + <tr valign="top">
1.62 + <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlSchema.html">XmlSchema</a></b></td>
1.63 + </tr>
1.64 + <tr valign="top">
1.65 + <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlSchemaType.html">XmlSchemaType</a></b></td>
1.66 + </tr>
1.67 + <tr valign="top">
1.68 + <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlSchemaTypes.html">XmlSchemaTypes</a></b></td>
1.69 + </tr>
1.70 + <tr valign="top">
1.71 + <td><b><a HREF="../../../../javax/xml/bind/annotation/adapters/XmlJavaTypeAdapter.html">XmlJavaTypeAdapter</a></b></td>
1.72 + </tr>
1.73 + <tr valign="top">
1.74 + <td><b><a HREF="../../../../javax/xml/bind/annotation/adapters/XmlJavaTypeAdapters.html">XmlJavaTypeAdapters</a></b></td>
1.75 + </tr>
1.76 + </table>
1.77 + </td>
1.78 + </tr>
1.79 +
1.80 + <tr valign="top">
1.81 + <td><b>Class</b></td>
1.82 + <td>
1.83 + <table>
1.84 + <tr valign="top">
1.85 + <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlAccessorOrder.html">XmlAccessorOrder</a></b></td>
1.86 + </tr>
1.87 + <tr valign="top">
1.88 + <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlAccessorType.html">XmlAccessorType</a></b></td>
1.89 + </tr>
1.90 + <tr valign="top">
1.91 + <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlInlineBinaryData.html">XmlInlineBinaryData</a></b></td>
1.92 + </tr>
1.93 + <tr valign="top">
1.94 + <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlRootElement.html">XmlRootElement</a></b></td>
1.95 + </tr>
1.96 + <tr valign="top">
1.97 + <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlType.html">XmlType</a></b></td>
1.98 + </tr>
1.99 + <tr valign="top">
1.100 + <td><b><a HREF="../../../../javax/xml/bind/annotation/adapters/XmlJavaTypeAdapter.html">XmlJavaTypeAdapter</a></b></td>
1.101 + </tr>
1.102 + </table>
1.103 + </td>
1.104 + </tr>
1.105 +
1.106 + <tr valign="top">
1.107 + <td><b>Enum type</b></td>
1.108 + <td>
1.109 + <table>
1.110 + <tr valign="top">
1.111 + <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlEnum.html">XmlEnum</a></b></td>
1.112 + </tr>
1.113 + <tr valign="top">
1.114 + <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlEnumValue.html">XmlEnumValue (enum constant only)</a></b></td>
1.115 + </tr>
1.116 + <tr valign="top">
1.117 + <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlRootElement.html">XmlRootElement</a></b></td>
1.118 + </tr>
1.119 + <tr valign="top">
1.120 + <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlType.html">XmlType</a></b></td>
1.121 + </tr>
1.122 + <tr valign="top">
1.123 + <td><b><a HREF="../../../../javax/xml/bind/annotation/adapters/XmlJavaTypeAdapter.html">XmlJavaTypeAdapter</a></b></td>
1.124 + </tr>
1.125 + </table>
1.126 + </td>
1.127 + </tr>
1.128 +
1.129 + <tr valign="top">
1.130 + <td><b>JavaBean Property/field</b></td>
1.131 + <td>
1.132 + <table>
1.133 + <tr valign="top">
1.134 + <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlElement.html">XmlElement</a></b></td>
1.135 + </tr>
1.136 + <tr valign="top">
1.137 + <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlElements.html">XmlElements</a></b></td>
1.138 + </tr>
1.139 + <tr valign="top">
1.140 + <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlElementRef.html">XmlElementRef</a></b></td>
1.141 + </tr>
1.142 + <tr valign="top">
1.143 + <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlElementRefs.html">XmlElementRefs</a></b></td>
1.144 + </tr>
1.145 + <tr valign="top">
1.146 + <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlElementWrapper.html">XmlElementWrapper</a></b></td>
1.147 + </tr>
1.148 + <tr valign="top">
1.149 + <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlAnyElement.html">XmlAnyElement</a></b></td>
1.150 + </tr>
1.151 + <tr valign="top">
1.152 + <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlAttribute.html">XmlAttribute</a></b></td>
1.153 + </tr>
1.154 + <tr valign="top">
1.155 + <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlAnyAttribute.html">XmlAnyAttribute</a></b></td>
1.156 + </tr>
1.157 + <tr valign="top">
1.158 + <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlTransient.html">XmlTransient</a></b></td>
1.159 + </tr>
1.160 + <tr valign="top">
1.161 + <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlValue.html">XmlValue</a></b></td>
1.162 + </tr>
1.163 + <tr valign="top">
1.164 + <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlID.html">XmlID</a></b></td>
1.165 + </tr>
1.166 + <tr valign="top">
1.167 + <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlIDREF.html">XmlIDREF</a></b></td>
1.168 + </tr>
1.169 + <tr valign="top">
1.170 + <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlList.html">XmlList</a></b></td>
1.171 + </tr>
1.172 + <tr valign="top">
1.173 + <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlMixed.html">XmlMixed</a></b></td>
1.174 + </tr>
1.175 + <tr valign="top">
1.176 + <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlMimeType.html">XmlMimeType</a></b></td>
1.177 + </tr>
1.178 + <tr valign="top">
1.179 + <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlAttachmentRef.html">XmlAttachmentRef</a></b></td>
1.180 + </tr>
1.181 + <tr valign="top">
1.182 + <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlInlineBinaryData.html">XmlInlineBinaryData</a></b></td>
1.183 + </tr>
1.184 + <tr valign="top">
1.185 + <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlElementDecl.html">XmlElementDecl (only on method)</a></b></td>
1.186 + </tr>
1.187 + <tr valign="top">
1.188 + <td><b><a HREF="../../../../javax/xml/bind/annotation/adapters/XmlJavaTypeAdapter.html">XmlJavaTypeAdapter</a></b></td>
1.189 + </tr>
1.190 + </table>
1.191 + </td>
1.192 + </tr>
1.193 +
1.194 + <tr valign="top">
1.195 + <td><b>Parameter</b></td>
1.196 + <td>
1.197 + <table>
1.198 + <tr valign="top">
1.199 + <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlList.html">XmlList</a></b></td>
1.200 + </tr>
1.201 + <tr valign="top">
1.202 + <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlAttachmentRef.html">XmlAttachmentRef</a></b></td>
1.203 + </tr>
1.204 + <tr valign="top">
1.205 + <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlMimeType.html">XmlMimeType</a></b></td>
1.206 + </tr>
1.207 + <tr valign="top">
1.208 + <td><b><a HREF="../../../../javax/xml/bind/annotation/adapters/XmlJavaTypeAdapter.html">XmlJavaTypeAdapter</a></b></td>
1.209 + </tr>
1.210 + </table>
1.211 + </td>
1.212 + </tr>
1.213 +
1.214 + </tbody>
1.215 + </table>
1.216 + <h3>Terminology</h3>
1.217 + <p>
1.218 + <b>JavaBean property and field:</b> For the purposes of
1.219 + mapping, there is no semantic difference between a field and
1.220 + a JavaBean property. Thus, an annotation that can be applied
1.221 + to a JavaBean property can always be applied to a
1.222 + field. Hence in the Javadoc documentation, for brevity, the
1.223 + term JavaBean property or property is used to mean either JavaBean
1.224 + property or a field. Where required, both are explicitly
1.225 + mentioned.
1.226 + <p>
1.227 + <b>top level class:</b> For the purpose of mapping, there is
1.228 + no semantic difference between a top level class and a
1.229 + static nested class. Thus, an annotation that can be applied
1.230 + to a top level class, can always be applied to a nested
1.231 + static class. Hence in the Javadoc documentation, for
1.232 + brevity, the term "top level class" or just class is used to
1.233 + mean either a top level class or a nested static
1.234 + class.
1.235 + <p>
1.236 + <b>mapping annotation:</b>A JAXB 2.0 defined program
1.237 + annotation based on the JSR 175 programming annotation
1.238 + facility.
1.239 + <h3>Common Usage Constraints</h3>
1.240 + <p>The following usage constraints are defined here since
1.241 + they apply to more than annotation:
1.242 + <ul>
1.243 + <li> For a property, a given annotation can be applied to
1.244 + either read or write property but not both. </li>
1.245 +
1.246 + <li> A property name must be different from any other
1.247 + property name in any of the super classes of the
1.248 + class being mapped. </li>
1.249 +
1.250 + <li> A mapped field name or the decapitalized name of a
1.251 + mapped property must be unique within a class. </li>
1.252 + </ul>
1.253 + <h3>Notations</h3>
1.254 + <b>Namespace prefixes</b>
1.255 + <p>The following namespace prefixes are used in the XML Schema
1.256 + fragments in this package.<p>
1.257 +
1.258 + <table border="1" cellpadding="4" cellspacing="3">
1.259 + <tbody>
1.260 + <tr>
1.261 + <td><b>Prefix</b></td>
1.262 + <td><b>Namespace</b></td>
1.263 + <td><b>Notes</b></td>
1.264 + </tr>
1.265 +
1.266 + <tr valign="top">
1.267 + <td>xs</td>
1.268 + <td>http://www.w3.org/2001/XMLSchema</td>
1.269 + <td>Namespace of XML Schema namespace</td>
1.270 + </tr>
1.271 + <tr valign="top">
1.272 + <td>ref</td>
1.273 + <td>http://ws-i.org/profiles/basic/1.1/xsd</td>
1.274 + <td>Namespace for swaref schema component</td>
1.275 + </tr>
1.276 + <tr valign="top">
1.277 + <td>xsi</td>
1.278 + <td>http://www.w3.org/2001/XMLSchema-instance</td>
1.279 + <td>XML Schema namespace for instances</td>
1.280 + </tr>
1.281 + </tbody>
1.282 + </table>
1.283 +
1.284 + <!-- Put @see and @since tags down here. -->
1.285 + @since JAXB 2.0
1.286 + </body>
1.287 +</html>
1.288 +
1.289 +
