bind/annotation/package.html

325N/A<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
325N/A<!--
325N/A Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved.
325N/A DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
325N/A
325N/A This code is free software; you can redistribute it and/or modify it
325N/A under the terms of the GNU General Public License version 2 only, as
325N/A published by the Free Software Foundation.  Oracle designates this
325N/A particular file as subject to the "Classpath" exception as provided
325N/A by Oracle in the LICENSE file that accompanied this code.
325N/A
325N/A This code is distributed in the hope that it will be useful, but WITHOUT
325N/A ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
325N/A FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
325N/A version 2 for more details (a copy is included in the LICENSE file that
325N/A accompanied this code).
325N/A
325N/A You should have received a copy of the GNU General Public License version
325N/A 2 along with this work; if not, write to the Free Software Foundation,
325N/A Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
325N/A
325N/A Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
325N/A or visit www.oracle.com if you need additional information or have any
325N/A questions.
325N/A-->
325N/A
325N/A<html>
325N/A    <head>
325N/A
325N/A
325N/A    </head>
325N/A
325N/A    <body bgcolor="white">
325N/A
325N/A        <p>
325N/A        Defines annotations for customizing Java program elements to XML Schema mapping.
325N/A
325N/A        <h2>Package Specification</h2>
325N/A        <p>The following table shows the JAXB mapping annotations
325N/A           that can be associated with each program element. </p>
325N/A
325N/A        <table border="1" cellpadding="4" cellspacing="3">
325N/A          <tbody>
325N/A            <tr>
325N/A              <td><b>Program Element</b></td>
325N/A              <td><b>JAXB annotation</b></td>
325N/A            </tr>
325N/A            <tr valign="top">
325N/A              <td><b>Package</b></td>
325N/A              <td>
325N/A                <table>
325N/A                  <tr valign="top">
325N/A                    <td><b><a HREF="/javax/xml/bind/annotation/XmlAccessorOrder.html">XmlAccessorOrder</a></b></td>
325N/A                  </tr>
325N/A                  <tr valign="top">
325N/A                    <td><b><a HREF="/javax/xml/bind/annotation/XmlAccessorType.html">XmlAccessorType</a></b></td>
325N/A                  </tr>
325N/A                  <tr valign="top">
325N/A                    <td><b><a HREF="/javax/xml/bind/annotation/XmlSchema.html">XmlSchema</a></b></td>
325N/A                  </tr>
325N/A                  <tr valign="top">
325N/A                    <td><b><a HREF="/javax/xml/bind/annotation/XmlSchemaType.html">XmlSchemaType</a></b></td>
325N/A                  </tr>
325N/A                  <tr valign="top">
325N/A                    <td><b><a HREF="/javax/xml/bind/annotation/XmlSchemaTypes.html">XmlSchemaTypes</a></b></td>
325N/A                  </tr>
325N/A                  <tr valign="top">
325N/A                    <td><b><a HREF="/javax/xml/bind/annotation/adapters/XmlJavaTypeAdapter.html">XmlJavaTypeAdapter</a></b></td>
325N/A                  </tr>
325N/A                  <tr valign="top">
325N/A                    <td><b><a HREF="/javax/xml/bind/annotation/adapters/XmlJavaTypeAdapters.html">XmlJavaTypeAdapters</a></b></td>
325N/A                  </tr>
325N/A                </table>
325N/A              </td>
325N/A            </tr>
325N/A
325N/A            <tr valign="top">
325N/A              <td><b>Class</b></td>
325N/A              <td>
325N/A                <table>
325N/A                  <tr valign="top">
325N/A                    <td><b><a HREF="/javax/xml/bind/annotation/XmlAccessorOrder.html">XmlAccessorOrder</a></b></td>
325N/A                  </tr>
325N/A                  <tr valign="top">
325N/A                    <td><b><a HREF="/javax/xml/bind/annotation/XmlAccessorType.html">XmlAccessorType</a></b></td>
325N/A                  </tr>
325N/A                  <tr valign="top">
325N/A                    <td><b><a HREF="/javax/xml/bind/annotation/XmlInlineBinaryData.html">XmlInlineBinaryData</a></b></td>
325N/A                  </tr>
325N/A                  <tr valign="top">
325N/A                    <td><b><a HREF="/javax/xml/bind/annotation/XmlRootElement.html">XmlRootElement</a></b></td>
325N/A                  </tr>
325N/A                  <tr valign="top">
325N/A                    <td><b><a HREF="/javax/xml/bind/annotation/XmlType.html">XmlType</a></b></td>
325N/A                  </tr>
325N/A                  <tr valign="top">
325N/A                    <td><b><a HREF="/javax/xml/bind/annotation/adapters/XmlJavaTypeAdapter.html">XmlJavaTypeAdapter</a></b></td>
325N/A                  </tr>
325N/A                </table>
325N/A              </td>
325N/A            </tr>
325N/A
325N/A            <tr valign="top">
325N/A              <td><b>Enum type</b></td>
325N/A              <td>
325N/A                <table>
325N/A                  <tr valign="top">
325N/A                    <td><b><a HREF="/javax/xml/bind/annotation/XmlEnum.html">XmlEnum</a></b></td>
325N/A                  </tr>
325N/A                  <tr valign="top">
325N/A                    <td><b><a HREF="/javax/xml/bind/annotation/XmlEnumValue.html">XmlEnumValue (enum constant only)</a></b></td>
325N/A                  </tr>
325N/A                  <tr valign="top">
325N/A                    <td><b><a HREF="/javax/xml/bind/annotation/XmlRootElement.html">XmlRootElement</a></b></td>
325N/A                  </tr>
325N/A                  <tr valign="top">
325N/A                    <td><b><a HREF="/javax/xml/bind/annotation/XmlType.html">XmlType</a></b></td>
325N/A                  </tr>
325N/A                  <tr valign="top">
325N/A                    <td><b><a HREF="/javax/xml/bind/annotation/adapters/XmlJavaTypeAdapter.html">XmlJavaTypeAdapter</a></b></td>
325N/A                  </tr>
325N/A                </table>
325N/A              </td>
325N/A            </tr>
325N/A
325N/A            <tr valign="top">
325N/A              <td><b>JavaBean Property/field</b></td>
325N/A              <td>
325N/A                <table>
325N/A                  <tr valign="top">
325N/A                    <td><b><a HREF="/javax/xml/bind/annotation/XmlElement.html">XmlElement</a></b></td>
325N/A                  </tr>
325N/A                  <tr valign="top">
325N/A                    <td><b><a HREF="/javax/xml/bind/annotation/XmlElements.html">XmlElements</a></b></td>
325N/A                  </tr>
325N/A                  <tr valign="top">
325N/A                    <td><b><a HREF="/javax/xml/bind/annotation/XmlElementRef.html">XmlElementRef</a></b></td>
325N/A                  </tr>
325N/A                  <tr valign="top">
325N/A                    <td><b><a HREF="/javax/xml/bind/annotation/XmlElementRefs.html">XmlElementRefs</a></b></td>
325N/A                  </tr>
325N/A                  <tr valign="top">
325N/A                    <td><b><a HREF="/javax/xml/bind/annotation/XmlElementWrapper.html">XmlElementWrapper</a></b></td>
325N/A                  </tr>
325N/A                  <tr valign="top">
325N/A                    <td><b><a HREF="/javax/xml/bind/annotation/XmlAnyElement.html">XmlAnyElement</a></b></td>
325N/A                  </tr>
325N/A                  <tr valign="top">
325N/A                    <td><b><a HREF="/javax/xml/bind/annotation/XmlAttribute.html">XmlAttribute</a></b></td>
325N/A                  </tr>
325N/A                  <tr valign="top">
325N/A                    <td><b><a HREF="/javax/xml/bind/annotation/XmlAnyAttribute.html">XmlAnyAttribute</a></b></td>
325N/A                  </tr>
325N/A                  <tr valign="top">
325N/A                    <td><b><a HREF="/javax/xml/bind/annotation/XmlTransient.html">XmlTransient</a></b></td>
325N/A                  </tr>
325N/A                  <tr valign="top">
325N/A                    <td><b><a HREF="/javax/xml/bind/annotation/XmlValue.html">XmlValue</a></b></td>
325N/A                  </tr>
325N/A                  <tr valign="top">
325N/A                    <td><b><a HREF="/javax/xml/bind/annotation/XmlID.html">XmlID</a></b></td>
325N/A                  </tr>
325N/A                  <tr valign="top">
325N/A                    <td><b><a HREF="/javax/xml/bind/annotation/XmlIDREF.html">XmlIDREF</a></b></td>
325N/A                  </tr>
325N/A                  <tr valign="top">
325N/A                    <td><b><a HREF="/javax/xml/bind/annotation/XmlList.html">XmlList</a></b></td>
325N/A                  </tr>
325N/A                  <tr valign="top">
325N/A                    <td><b><a HREF="/javax/xml/bind/annotation/XmlMixed.html">XmlMixed</a></b></td>
325N/A                  </tr>
325N/A                  <tr valign="top">
325N/A                    <td><b><a HREF="/javax/xml/bind/annotation/XmlMimeType.html">XmlMimeType</a></b></td>
325N/A                  </tr>
325N/A                  <tr valign="top">
325N/A                    <td><b><a HREF="/javax/xml/bind/annotation/XmlAttachmentRef.html">XmlAttachmentRef</a></b></td>
325N/A                  </tr>
325N/A                  <tr valign="top">
325N/A                    <td><b><a HREF="/javax/xml/bind/annotation/XmlInlineBinaryData.html">XmlInlineBinaryData</a></b></td>
325N/A                  </tr>
325N/A                  <tr valign="top">
325N/A                    <td><b><a HREF="/javax/xml/bind/annotation/XmlElementDecl.html">XmlElementDecl (only on method)</a></b></td>
325N/A                  </tr>
325N/A                  <tr valign="top">
325N/A                    <td><b><a HREF="/javax/xml/bind/annotation/adapters/XmlJavaTypeAdapter.html">XmlJavaTypeAdapter</a></b></td>
325N/A                  </tr>
325N/A                </table>
325N/A              </td>
325N/A            </tr>
325N/A
325N/A            <tr valign="top">
325N/A              <td><b>Parameter</b></td>
325N/A              <td>
325N/A                <table>
325N/A                  <tr valign="top">
325N/A                    <td><b><a HREF="/javax/xml/bind/annotation/XmlList.html">XmlList</a></b></td>
325N/A                  </tr>
325N/A                  <tr valign="top">
325N/A                    <td><b><a HREF="/javax/xml/bind/annotation/XmlAttachmentRef.html">XmlAttachmentRef</a></b></td>
325N/A                  </tr>
325N/A                  <tr valign="top">
325N/A                    <td><b><a HREF="/javax/xml/bind/annotation/XmlMimeType.html">XmlMimeType</a></b></td>
325N/A                  </tr>
325N/A                  <tr valign="top">
325N/A                    <td><b><a HREF="/javax/xml/bind/annotation/adapters/XmlJavaTypeAdapter.html">XmlJavaTypeAdapter</a></b></td>
325N/A                  </tr>
325N/A                </table>
325N/A              </td>
325N/A            </tr>
325N/A
325N/A          </tbody>
325N/A        </table>
325N/A        <h3>Terminology</h3>
325N/A          <p>
325N/A          <b>JavaBean property and field:</b> For the purposes of
325N/A          mapping, there is no semantic difference between a field and
325N/A          a JavaBean property. Thus, an annotation that can be applied
325N/A          to a JavaBean property can always be applied to a
325N/A          field. Hence in the Javadoc documentation, for brevity, the
325N/A          term JavaBean property or property is used to mean either JavaBean
325N/A          property or a field. Where required, both are explicitly
325N/A          mentioned.
325N/A          <p>
325N/A          <b>top level class:</b> For the purpose of mapping, there is
325N/A          no semantic difference between a top level class and a
325N/A          static nested class. Thus, an annotation that can be applied
325N/A          to a top level class, can always be applied to a nested
325N/A          static class. Hence in the Javadoc documentation, for
325N/A          brevity, the term "top level class" or just class is used to
325N/A          mean either a top level class or a nested static
325N/A          class.
325N/A          <p>
325N/A          <b>mapping annotation:</b>A JAXB 2.0 defined program
325N/A          annotation based on the JSR 175 programming annotation
325N/A          facility.
325N/A         <h3>Common Usage Constraints</h3>
325N/A          <p>The following usage constraints are defined here since
325N/A          they apply to more than annotation:
325N/A          <ul>
325N/A            <li> For a property, a given annotation can be applied to
325N/A                 either read or write property but not both. </li>
325N/A
325N/A            <li> A property name must be different from any other
325N/A                 property name in any of the super classes of the
325N/A                 class being mapped. </li>
325N/A
325N/A            <li> A mapped field name or the decapitalized name of a
325N/A                 mapped property must be unique within a class. </li>
325N/A          </ul>
325N/A         <h3>Notations</h3>
325N/A         <b>Namespace prefixes</b>
325N/A         <p>The following namespace prefixes are used in the XML Schema
325N/A           fragments in this package.<p>
325N/A
325N/A        <table border="1" cellpadding="4" cellspacing="3">
325N/A          <tbody>
325N/A            <tr>
325N/A              <td><b>Prefix</b></td>
325N/A              <td><b>Namespace</b></td>
325N/A              <td><b>Notes</b></td>
325N/A           </tr>
325N/A
325N/A           <tr valign="top">
325N/A             <td>xs</td>
325N/A             <td>http://www.w3.org/2001/XMLSchema</td>
325N/A             <td>Namespace of XML Schema namespace</td>
325N/A           </tr>
325N/A           <tr valign="top">
325N/A             <td>ref</td>
325N/A             <td>http://ws-i.org/profiles/basic/1.1/xsd</td>
325N/A             <td>Namespace for swaref schema component</td>
325N/A           </tr>
325N/A           <tr valign="top">
325N/A             <td>xsi</td>
325N/A             <td>http://www.w3.org/2001/XMLSchema-instance</td>
325N/A             <td>XML Schema namespace for instances</td>
325N/A           </tr>
325N/A          </tbody>
325N/A        </table>
325N/A
325N/A        <!-- Put @see and @since tags down here. -->
325N/A        @since JAXB 2.0
325N/A    </body>
325N/A</html>
325N/A
325N/A