diff src/share/classes/javax/xml/bind/annotation/package.html @ 0:0961a4a21176

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