javadoc/help-doc.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <!--NewPage-->
   3 <HTML>
   4 <HEAD>
   5 <!-- Generated by javadoc (build 1.6.0_0) on Tue Feb 02 14:44:20 CET 2010 -->
   6 <TITLE>
   7 API Help
   8 </TITLE>
   9
  10 <META NAME="date" CONTENT="2010-02-02">
  11
  12 <LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
  13
  14 <SCRIPT type="text/javascript">
  15 function windowTitle()
  16 {
  17     if (location.href.indexOf('is-external=true') == -1) {
  18         parent.document.title="API Help";
  19     }
  20 }
  21 </SCRIPT>
  22 <NOSCRIPT>
  23 </NOSCRIPT>
  24
  25 </HEAD>
  26
  27 <BODY BGCOLOR="white" onload="windowTitle();">
  28 <HR>
  29
  30
  31 <!-- ========= START OF TOP NAVBAR ======= -->
  32 <A NAME="navbar_top"><!-- --></A>
  33 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
  34 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  35 <TR>
  36 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  37 <A NAME="navbar_top_firstrow"><!-- --></A>
  38 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  39   <TR ALIGN="center" VALIGN="top">
  40   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="and/Mapping/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  41   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
  42   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Use</FONT>&nbsp;</TD>
  43   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="and/Mapping/package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  44   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  45   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  46   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Help</B></FONT>&nbsp;</TD>
  47   </TR>
  48 </TABLE>
  49 </TD>
  50 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  51 </EM>
  52 </TD>
  53 </TR>
  54
  55 <TR>
  56 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  57 &nbsp;PREV&nbsp;
  58 &nbsp;NEXT</FONT></TD>
  59 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  60   <A HREF="index.html?help-doc.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  61 &nbsp;<A HREF="help-doc.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
  62 &nbsp;<SCRIPT type="text/javascript">
  63   <!--
  64   if(window==top) {
  65     document.writeln('<A HREF="allclasses-noframe.html"><B>All Classes</B></A>');
  66   }
  67   //-->
  68 </SCRIPT>
  69 <NOSCRIPT>
  70   <A HREF="allclasses-noframe.html"><B>All Classes</B></A>
  71 </NOSCRIPT>
  72
  73
  74 </FONT></TD>
  75 </TR>
  76 </TABLE>
  77 <A NAME="skip-navbar_top"></A>
  78 <!-- ========= END OF TOP NAVBAR ========= -->
  79
  80 <HR>
  81 <CENTER>
  82 <H1>
  83 How This API Document Is Organized</H1>
  84 </CENTER>
  85 This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.<H3>
  86 Package</H3>
  87 <BLOCKQUOTE>
  88
  89 <P>
  90 Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain four categories:<UL>
  91 <LI>Interfaces (italic)<LI>Classes<LI>Enums<LI>Exceptions<LI>Errors<LI>Annotation Types</UL>
  92 </BLOCKQUOTE>
  93 <H3>
  94 Class/Interface</H3>
  95 <BLOCKQUOTE>
  96
  97 <P>
  98 Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:<UL>
  99 <LI>Class inheritance diagram<LI>Direct Subclasses<LI>All Known Subinterfaces<LI>All Known Implementing Classes<LI>Class/interface declaration<LI>Class/interface description
 100 <P>
 101 <LI>Nested Class Summary<LI>Field Summary<LI>Constructor Summary<LI>Method Summary
 102 <P>
 103 <LI>Field Detail<LI>Constructor Detail<LI>Method Detail</UL>
 104 Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.</BLOCKQUOTE>
 105 </BLOCKQUOTE>
 106 <H3>
 107 Annotation Type</H3>
 108 <BLOCKQUOTE>
 109
 110 <P>
 111 Each annotation type has its own separate page with the following sections:<UL>
 112 <LI>Annotation Type declaration<LI>Annotation Type description<LI>Required Element Summary<LI>Optional Element Summary<LI>Element Detail</UL>
 113 </BLOCKQUOTE>
 114 </BLOCKQUOTE>
 115 <H3>
 116 Enum</H3>
 117 <BLOCKQUOTE>
 118
 119 <P>
 120 Each enum has its own separate page with the following sections:<UL>
 121 <LI>Enum declaration<LI>Enum description<LI>Enum Constant Summary<LI>Enum Constant Detail</UL>
 122 </BLOCKQUOTE>
 123 <H3>
 124 Use</H3>
 125 <BLOCKQUOTE>
 126 Each documented package, class and interface has its own Use page.  This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A.  You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.</BLOCKQUOTE>
 127 <H3>
 128 Tree (Class Hierarchy)</H3>
 129 <BLOCKQUOTE>
 130 There is a <A HREF="overview-tree.html">Class Hierarchy</A> page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with <code>java.lang.Object</code>. The interfaces do not inherit from <code>java.lang.Object</code>.<UL>
 131 <LI>When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.<LI>When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.</UL>
 132 </BLOCKQUOTE>
 133 <H3>
 134 Deprecated API</H3>
 135 <BLOCKQUOTE>
 136 The <A HREF="deprecated-list.html">Deprecated API</A> page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.</BLOCKQUOTE>
 137 <H3>
 138 Index</H3>
 139 <BLOCKQUOTE>
 140 The <A HREF="index-files/index-1.html">Index</A> contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.</BLOCKQUOTE>
 141 <H3>
 142 Prev/Next</H3>
 143 These links take you to the next or previous class, interface, package, or related page.<H3>
 144 Frames/No Frames</H3>
 145 These links show and hide the HTML frames.  All pages are available with or without frames.
 146 <P>
 147 <H3>
 148 Serialized Form</H3>
 149 Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.
 150 <P>
 151 <H3>
 152 Constant Field Values</H3>
 153 The <a href="constant-values.html">Constant Field Values</a> page lists the static final fields and their values.
 154 <P>
 155 <FONT SIZE="-1">
 156 <EM>
 157 This help file applies to API documentation generated using the standard doclet.</EM>
 158 </FONT>
 159 <BR>
 160 <HR>
 161
 162
 163 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 164 <A NAME="navbar_bottom"><!-- --></A>
 165 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
 166 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 167 <TR>
 168 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 169 <A NAME="navbar_bottom_firstrow"><!-- --></A>
 170 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 171   <TR ALIGN="center" VALIGN="top">
 172   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="and/Mapping/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 173   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
 174   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Use</FONT>&nbsp;</TD>
 175   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="and/Mapping/package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 176   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 177   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 178   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Help</B></FONT>&nbsp;</TD>
 179   </TR>
 180 </TABLE>
 181 </TD>
 182 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 183 </EM>
 184 </TD>
 185 </TR>
 186
 187 <TR>
 188 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 189 &nbsp;PREV&nbsp;
 190 &nbsp;NEXT</FONT></TD>
 191 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 192   <A HREF="index.html?help-doc.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 193 &nbsp;<A HREF="help-doc.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 194 &nbsp;<SCRIPT type="text/javascript">
 195   <!--
 196   if(window==top) {
 197     document.writeln('<A HREF="allclasses-noframe.html"><B>All Classes</B></A>');
 198   }
 199   //-->
 200 </SCRIPT>
 201 <NOSCRIPT>
 202   <A HREF="allclasses-noframe.html"><B>All Classes</B></A>
 203 </NOSCRIPT>
 204
 205
 206 </FONT></TD>
 207 </TR>
 208 </TABLE>
 209 <A NAME="skip-navbar_bottom"></A>
 210 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 211
 212 <HR>
 213
 214 </BODY>
 215 </HTML>