Mercurial > jdk8-mips64-public > jaxws / annotate
src/share/jaxws_classes/javax/xml/bind/annotation/package.html@0989ad8c0860 (annotated)
src/share/jaxws_classes/javax/xml/bind/annotation/package.html
Tue, 09 Apr 2013 14:51:13 +0100
- author
- alanb
- date
- Tue, 09 Apr 2013 14:51:13 +0100
- changeset 368
- 0989ad8c0860
- parent 286
- f50545b5e2f1
- child 397
- b99d7e355d4b
- permissions
- -rw-r--r--
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 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> |
| ohair@286 | 2 | <!-- |
| ohair@286 | 3 | Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved. |
| ohair@286 | 4 | DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| ohair@286 | 5 | |
| ohair@286 | 6 | This code is free software; you can redistribute it and/or modify it |
| ohair@286 | 7 | under the terms of the GNU General Public License version 2 only, as |
| ohair@286 | 8 | published by the Free Software Foundation. Oracle designates this |
| ohair@286 | 9 | particular file as subject to the "Classpath" exception as provided |
| ohair@286 | 10 | by Oracle in the LICENSE file that accompanied this code. |
| ohair@286 | 11 | |
| ohair@286 | 12 | This code is distributed in the hope that it will be useful, but WITHOUT |
| ohair@286 | 13 | ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| ohair@286 | 14 | FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| ohair@286 | 15 | version 2 for more details (a copy is included in the LICENSE file that |
| ohair@286 | 16 | accompanied this code). |
| ohair@286 | 17 | |
| ohair@286 | 18 | You should have received a copy of the GNU General Public License version |
| ohair@286 | 19 | 2 along with this work; if not, write to the Free Software Foundation, |
| ohair@286 | 20 | Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| ohair@286 | 21 | |
| ohair@286 | 22 | Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| ohair@286 | 23 | or visit www.oracle.com if you need additional information or have any |
| ohair@286 | 24 | questions. |
| ohair@286 | 25 | --> |
| ohair@286 | 26 | |
| ohair@286 | 27 | <html> |
| ohair@286 | 28 | <head> |
| ohair@286 | 29 | |
| ohair@286 | 30 | |
| ohair@286 | 31 | </head> |
| ohair@286 | 32 | |
| ohair@286 | 33 | <body bgcolor="white"> |
| ohair@286 | 34 | |
| ohair@286 | 35 | <p> |
| ohair@286 | 36 | Defines annotations for customizing Java program elements to XML Schema mapping. |
| ohair@286 | 37 | |
| ohair@286 | 38 | <h2>Package Specification</h2> |
| ohair@286 | 39 | <p>The following table shows the JAXB mapping annotations |
| ohair@286 | 40 | that can be associated with each program element. </p> |
| ohair@286 | 41 | |
| ohair@286 | 42 | <table border="1" cellpadding="4" cellspacing="3"> |
| ohair@286 | 43 | <tbody> |
| ohair@286 | 44 | <tr> |
| ohair@286 | 45 | <td><b>Program Element</b></td> |
| ohair@286 | 46 | <td><b>JAXB annotation</b></td> |
| ohair@286 | 47 | </tr> |
| ohair@286 | 48 | <tr valign="top"> |
| ohair@286 | 49 | <td><b>Package</b></td> |
| ohair@286 | 50 | <td> |
| ohair@286 | 51 | <table> |
| ohair@286 | 52 | <tr valign="top"> |
| ohair@286 | 53 | <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlAccessorOrder.html">XmlAccessorOrder</a></b></td> |
| ohair@286 | 54 | </tr> |
| ohair@286 | 55 | <tr valign="top"> |
| ohair@286 | 56 | <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlAccessorType.html">XmlAccessorType</a></b></td> |
| ohair@286 | 57 | </tr> |
| ohair@286 | 58 | <tr valign="top"> |
| ohair@286 | 59 | <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlSchema.html">XmlSchema</a></b></td> |
| ohair@286 | 60 | </tr> |
| ohair@286 | 61 | <tr valign="top"> |
| ohair@286 | 62 | <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlSchemaType.html">XmlSchemaType</a></b></td> |
| ohair@286 | 63 | </tr> |
| ohair@286 | 64 | <tr valign="top"> |
| ohair@286 | 65 | <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlSchemaTypes.html">XmlSchemaTypes</a></b></td> |
| ohair@286 | 66 | </tr> |
| ohair@286 | 67 | <tr valign="top"> |
| ohair@286 | 68 | <td><b><a HREF="../../../../javax/xml/bind/annotation/adapters/XmlJavaTypeAdapter.html">XmlJavaTypeAdapter</a></b></td> |
| ohair@286 | 69 | </tr> |
| ohair@286 | 70 | <tr valign="top"> |
| ohair@286 | 71 | <td><b><a HREF="../../../../javax/xml/bind/annotation/adapters/XmlJavaTypeAdapters.html">XmlJavaTypeAdapters</a></b></td> |
| ohair@286 | 72 | </tr> |
| ohair@286 | 73 | </table> |
| ohair@286 | 74 | </td> |
| ohair@286 | 75 | </tr> |
| ohair@286 | 76 | |
| ohair@286 | 77 | <tr valign="top"> |
| ohair@286 | 78 | <td><b>Class</b></td> |
| ohair@286 | 79 | <td> |
| ohair@286 | 80 | <table> |
| ohair@286 | 81 | <tr valign="top"> |
| ohair@286 | 82 | <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlAccessorOrder.html">XmlAccessorOrder</a></b></td> |
| ohair@286 | 83 | </tr> |
| ohair@286 | 84 | <tr valign="top"> |
| ohair@286 | 85 | <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlAccessorType.html">XmlAccessorType</a></b></td> |
| ohair@286 | 86 | </tr> |
| ohair@286 | 87 | <tr valign="top"> |
| ohair@286 | 88 | <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlInlineBinaryData.html">XmlInlineBinaryData</a></b></td> |
| ohair@286 | 89 | </tr> |
| ohair@286 | 90 | <tr valign="top"> |
| ohair@286 | 91 | <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlRootElement.html">XmlRootElement</a></b></td> |
| ohair@286 | 92 | </tr> |
| ohair@286 | 93 | <tr valign="top"> |
| ohair@286 | 94 | <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlType.html">XmlType</a></b></td> |
| ohair@286 | 95 | </tr> |
| ohair@286 | 96 | <tr valign="top"> |
| ohair@286 | 97 | <td><b><a HREF="../../../../javax/xml/bind/annotation/adapters/XmlJavaTypeAdapter.html">XmlJavaTypeAdapter</a></b></td> |
| ohair@286 | 98 | </tr> |
| ohair@286 | 99 | </table> |
| ohair@286 | 100 | </td> |
| ohair@286 | 101 | </tr> |
| ohair@286 | 102 | |
| ohair@286 | 103 | <tr valign="top"> |
| ohair@286 | 104 | <td><b>Enum type</b></td> |
| ohair@286 | 105 | <td> |
| ohair@286 | 106 | <table> |
| ohair@286 | 107 | <tr valign="top"> |
| ohair@286 | 108 | <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlEnum.html">XmlEnum</a></b></td> |
| ohair@286 | 109 | </tr> |
| ohair@286 | 110 | <tr valign="top"> |
| ohair@286 | 111 | <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlEnumValue.html">XmlEnumValue (enum constant only)</a></b></td> |
| ohair@286 | 112 | </tr> |
| ohair@286 | 113 | <tr valign="top"> |
| ohair@286 | 114 | <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlRootElement.html">XmlRootElement</a></b></td> |
| ohair@286 | 115 | </tr> |
| ohair@286 | 116 | <tr valign="top"> |
| ohair@286 | 117 | <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlType.html">XmlType</a></b></td> |
| ohair@286 | 118 | </tr> |
| ohair@286 | 119 | <tr valign="top"> |
| ohair@286 | 120 | <td><b><a HREF="../../../../javax/xml/bind/annotation/adapters/XmlJavaTypeAdapter.html">XmlJavaTypeAdapter</a></b></td> |
| ohair@286 | 121 | </tr> |
| ohair@286 | 122 | </table> |
| ohair@286 | 123 | </td> |
| ohair@286 | 124 | </tr> |
| ohair@286 | 125 | |
| ohair@286 | 126 | <tr valign="top"> |
| ohair@286 | 127 | <td><b>JavaBean Property/field</b></td> |
| ohair@286 | 128 | <td> |
| ohair@286 | 129 | <table> |
| ohair@286 | 130 | <tr valign="top"> |
| ohair@286 | 131 | <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlElement.html">XmlElement</a></b></td> |
| ohair@286 | 132 | </tr> |
| ohair@286 | 133 | <tr valign="top"> |
| ohair@286 | 134 | <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlElements.html">XmlElements</a></b></td> |
| ohair@286 | 135 | </tr> |
| ohair@286 | 136 | <tr valign="top"> |
| ohair@286 | 137 | <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlElementRef.html">XmlElementRef</a></b></td> |
| ohair@286 | 138 | </tr> |
| ohair@286 | 139 | <tr valign="top"> |
| ohair@286 | 140 | <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlElementRefs.html">XmlElementRefs</a></b></td> |
| ohair@286 | 141 | </tr> |
| ohair@286 | 142 | <tr valign="top"> |
| ohair@286 | 143 | <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlElementWrapper.html">XmlElementWrapper</a></b></td> |
| ohair@286 | 144 | </tr> |
| ohair@286 | 145 | <tr valign="top"> |
| ohair@286 | 146 | <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlAnyElement.html">XmlAnyElement</a></b></td> |
| ohair@286 | 147 | </tr> |
| ohair@286 | 148 | <tr valign="top"> |
| ohair@286 | 149 | <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlAttribute.html">XmlAttribute</a></b></td> |
| ohair@286 | 150 | </tr> |
| ohair@286 | 151 | <tr valign="top"> |
| ohair@286 | 152 | <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlAnyAttribute.html">XmlAnyAttribute</a></b></td> |
| ohair@286 | 153 | </tr> |
| ohair@286 | 154 | <tr valign="top"> |
| ohair@286 | 155 | <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlTransient.html">XmlTransient</a></b></td> |
| ohair@286 | 156 | </tr> |
| ohair@286 | 157 | <tr valign="top"> |
| ohair@286 | 158 | <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlValue.html">XmlValue</a></b></td> |
| ohair@286 | 159 | </tr> |
| ohair@286 | 160 | <tr valign="top"> |
| ohair@286 | 161 | <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlID.html">XmlID</a></b></td> |
| ohair@286 | 162 | </tr> |
| ohair@286 | 163 | <tr valign="top"> |
| ohair@286 | 164 | <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlIDREF.html">XmlIDREF</a></b></td> |
| ohair@286 | 165 | </tr> |
| ohair@286 | 166 | <tr valign="top"> |
| ohair@286 | 167 | <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlList.html">XmlList</a></b></td> |
| ohair@286 | 168 | </tr> |
| ohair@286 | 169 | <tr valign="top"> |
| ohair@286 | 170 | <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlMixed.html">XmlMixed</a></b></td> |
| ohair@286 | 171 | </tr> |
| ohair@286 | 172 | <tr valign="top"> |
| ohair@286 | 173 | <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlMimeType.html">XmlMimeType</a></b></td> |
| ohair@286 | 174 | </tr> |
| ohair@286 | 175 | <tr valign="top"> |
| ohair@286 | 176 | <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlAttachmentRef.html">XmlAttachmentRef</a></b></td> |
| ohair@286 | 177 | </tr> |
| ohair@286 | 178 | <tr valign="top"> |
| ohair@286 | 179 | <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlInlineBinaryData.html">XmlInlineBinaryData</a></b></td> |
| ohair@286 | 180 | </tr> |
| ohair@286 | 181 | <tr valign="top"> |
| ohair@286 | 182 | <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlElementDecl.html">XmlElementDecl (only on method)</a></b></td> |
| ohair@286 | 183 | </tr> |
| ohair@286 | 184 | <tr valign="top"> |
| ohair@286 | 185 | <td><b><a HREF="../../../../javax/xml/bind/annotation/adapters/XmlJavaTypeAdapter.html">XmlJavaTypeAdapter</a></b></td> |
| ohair@286 | 186 | </tr> |
| ohair@286 | 187 | </table> |
| ohair@286 | 188 | </td> |
| ohair@286 | 189 | </tr> |
| ohair@286 | 190 | |
| ohair@286 | 191 | <tr valign="top"> |
| ohair@286 | 192 | <td><b>Parameter</b></td> |
| ohair@286 | 193 | <td> |
| ohair@286 | 194 | <table> |
| ohair@286 | 195 | <tr valign="top"> |
| ohair@286 | 196 | <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlList.html">XmlList</a></b></td> |
| ohair@286 | 197 | </tr> |
| ohair@286 | 198 | <tr valign="top"> |
| ohair@286 | 199 | <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlAttachmentRef.html">XmlAttachmentRef</a></b></td> |
| ohair@286 | 200 | </tr> |
| ohair@286 | 201 | <tr valign="top"> |
| ohair@286 | 202 | <td><b><a HREF="../../../../javax/xml/bind/annotation/XmlMimeType.html">XmlMimeType</a></b></td> |
| ohair@286 | 203 | </tr> |
| ohair@286 | 204 | <tr valign="top"> |
| ohair@286 | 205 | <td><b><a HREF="../../../../javax/xml/bind/annotation/adapters/XmlJavaTypeAdapter.html">XmlJavaTypeAdapter</a></b></td> |
| ohair@286 | 206 | </tr> |
| ohair@286 | 207 | </table> |
| ohair@286 | 208 | </td> |
| ohair@286 | 209 | </tr> |
| ohair@286 | 210 | |
| ohair@286 | 211 | </tbody> |
| ohair@286 | 212 | </table> |
| ohair@286 | 213 | <h3>Terminology</h3> |
| ohair@286 | 214 | <p> |
| ohair@286 | 215 | <b>JavaBean property and field:</b> For the purposes of |
| ohair@286 | 216 | mapping, there is no semantic difference between a field and |
| ohair@286 | 217 | a JavaBean property. Thus, an annotation that can be applied |
| ohair@286 | 218 | to a JavaBean property can always be applied to a |
| ohair@286 | 219 | field. Hence in the Javadoc documentation, for brevity, the |
| ohair@286 | 220 | term JavaBean property or property is used to mean either JavaBean |
| ohair@286 | 221 | property or a field. Where required, both are explicitly |
| ohair@286 | 222 | mentioned. |
| ohair@286 | 223 | <p> |
| ohair@286 | 224 | <b>top level class:</b> For the purpose of mapping, there is |
| ohair@286 | 225 | no semantic difference between a top level class and a |
| ohair@286 | 226 | static nested class. Thus, an annotation that can be applied |
| ohair@286 | 227 | to a top level class, can always be applied to a nested |
| ohair@286 | 228 | static class. Hence in the Javadoc documentation, for |
| ohair@286 | 229 | brevity, the term "top level class" or just class is used to |
| ohair@286 | 230 | mean either a top level class or a nested static |
| ohair@286 | 231 | class. |
| ohair@286 | 232 | <p> |
| ohair@286 | 233 | <b>mapping annotation:</b>A JAXB 2.0 defined program |
| ohair@286 | 234 | annotation based on the JSR 175 programming annotation |
| ohair@286 | 235 | facility. |
| ohair@286 | 236 | <h3>Common Usage Constraints</h3> |
| ohair@286 | 237 | <p>The following usage constraints are defined here since |
| ohair@286 | 238 | they apply to more than annotation: |
| ohair@286 | 239 | <ul> |
| ohair@286 | 240 | <li> For a property, a given annotation can be applied to |
| ohair@286 | 241 | either read or write property but not both. </li> |
| ohair@286 | 242 | |
| ohair@286 | 243 | <li> A property name must be different from any other |
| ohair@286 | 244 | property name in any of the super classes of the |
| ohair@286 | 245 | class being mapped. </li> |
| ohair@286 | 246 | |
| ohair@286 | 247 | <li> A mapped field name or the decapitalized name of a |
| ohair@286 | 248 | mapped property must be unique within a class. </li> |
| ohair@286 | 249 | </ul> |
| ohair@286 | 250 | <h3>Notations</h3> |
| ohair@286 | 251 | <b>Namespace prefixes</b> |
| ohair@286 | 252 | <p>The following namespace prefixes are used in the XML Schema |
| ohair@286 | 253 | fragments in this package.<p> |
| ohair@286 | 254 | |
| ohair@286 | 255 | <table border="1" cellpadding="4" cellspacing="3"> |
| ohair@286 | 256 | <tbody> |
| ohair@286 | 257 | <tr> |
| ohair@286 | 258 | <td><b>Prefix</b></td> |
| ohair@286 | 259 | <td><b>Namespace</b></td> |
| ohair@286 | 260 | <td><b>Notes</b></td> |
| ohair@286 | 261 | </tr> |
| ohair@286 | 262 | |
| ohair@286 | 263 | <tr valign="top"> |
| ohair@286 | 264 | <td>xs</td> |
| ohair@286 | 265 | <td>http://www.w3.org/2001/XMLSchema</td> |
| ohair@286 | 266 | <td>Namespace of XML Schema namespace</td> |
| ohair@286 | 267 | </tr> |
| ohair@286 | 268 | <tr valign="top"> |
| ohair@286 | 269 | <td>ref</td> |
| ohair@286 | 270 | <td>http://ws-i.org/profiles/basic/1.1/xsd</td> |
| ohair@286 | 271 | <td>Namespace for swaref schema component</td> |
| ohair@286 | 272 | </tr> |
| ohair@286 | 273 | <tr valign="top"> |
| ohair@286 | 274 | <td>xsi</td> |
| ohair@286 | 275 | <td>http://www.w3.org/2001/XMLSchema-instance</td> |
| ohair@286 | 276 | <td>XML Schema namespace for instances</td> |
| ohair@286 | 277 | </tr> |
| ohair@286 | 278 | </tbody> |
| ohair@286 | 279 | </table> |
| ohair@286 | 280 | |
| ohair@286 | 281 | <!-- Put @see and @since tags down here. --> |
| ohair@286 | 282 | @since JAXB 2.0 |
| ohair@286 | 283 | </body> |
| ohair@286 | 284 | </html> |
| ohair@286 | 285 | |
| ohair@286 | 286 |
