doc/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_18) on Mon Jul 05 12:01:13 CEST 2010 -->
   6 <TITLE>
   7 API Help
   8 </TITLE>
   9
  10 <META NAME="date" CONTENT="2010-07-05">
  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="overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  41   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Package</FONT>&nbsp;</TD>
  42   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
  43   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Use</FONT>&nbsp;</TD>
  44   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="overview-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  45   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  46   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  47   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Help</B></FONT>&nbsp;</TD>
  48   </TR>
  49 </TABLE>
  50 </TD>
  51 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  52 </EM>
  53 </TD>
  54 </TR>
  55
  56 <TR>
  57 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  58 &nbsp;PREV&nbsp;
  59 &nbsp;NEXT</FONT></TD>
  60 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  61   <A HREF="index.html?help-doc.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  62 &nbsp;<A HREF="help-doc.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
  63 &nbsp;<SCRIPT type="text/javascript">
  64   <!--
  65   if(window==top) {
  66     document.writeln('<A HREF="allclasses-noframe.html"><B>All Classes</B></A>');
  67   }
  68   //-->
  69 </SCRIPT>
  70 <NOSCRIPT>
  71   <A HREF="allclasses-noframe.html"><B>All Classes</B></A>
  72 </NOSCRIPT>
  73
  74
  75 </FONT></TD>
  76 </TR>
  77 </TABLE>
  78 <A NAME="skip-navbar_top"></A>
  79 <!-- ========= END OF TOP NAVBAR ========= -->
  80
  81 <HR>
  82 <CENTER>
  83 <H1>
  84 How This API Document Is Organized</H1>
  85 </CENTER>
  86 This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.<H3>
  87 Overview</H3>
  88 <BLOCKQUOTE>
  89
  90 <P>
  91 The <A HREF="overview-summary.html">Overview</A> page is the front page of this API document and provides a list of all packages with a summary for each.  This page can also contain an overall description of the set of packages.</BLOCKQUOTE>
  92 <H3>
  93 Package</H3>
  94 <BLOCKQUOTE>
  95
  96 <P>
  97 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>
  98 <LI>Interfaces (italic)<LI>Classes<LI>Enums<LI>Exceptions<LI>Errors<LI>Annotation Types</UL>
  99 </BLOCKQUOTE>
 100 <H3>
 101 Class/Interface</H3>
 102 <BLOCKQUOTE>
 103
 104 <P>
 105 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>
 106 <LI>Class inheritance diagram<LI>Direct Subclasses<LI>All Known Subinterfaces<LI>All Known Implementing Classes<LI>Class/interface declaration<LI>Class/interface description
 107 <P>
 108 <LI>Nested Class Summary<LI>Field Summary<LI>Constructor Summary<LI>Method Summary
 109 <P>
 110 <LI>Field Detail<LI>Constructor Detail<LI>Method Detail</UL>
 111 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>
 112 </BLOCKQUOTE>
 113 <H3>
 114 Annotation Type</H3>
 115 <BLOCKQUOTE>
 116
 117 <P>
 118 Each annotation type has its own separate page with the following sections:<UL>
 119 <LI>Annotation Type declaration<LI>Annotation Type description<LI>Required Element Summary<LI>Optional Element Summary<LI>Element Detail</UL>
 120 </BLOCKQUOTE>
 121 </BLOCKQUOTE>
 122 <H3>
 123 Enum</H3>
 124 <BLOCKQUOTE>
 125
 126 <P>
 127 Each enum has its own separate page with the following sections:<UL>
 128 <LI>Enum declaration<LI>Enum description<LI>Enum Constant Summary<LI>Enum Constant Detail</UL>
 129 </BLOCKQUOTE>
 130 <H3>
 131 Use</H3>
 132 <BLOCKQUOTE>
 133 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>
 134 <H3>
 135 Tree (Class Hierarchy)</H3>
 136 <BLOCKQUOTE>
 137 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>
 138 <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>
 139 </BLOCKQUOTE>
 140 <H3>
 141 Deprecated API</H3>
 142 <BLOCKQUOTE>
 143 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>
 144 <H3>
 145 Index</H3>
 146 <BLOCKQUOTE>
 147 The <A HREF="index-files/index-1.html">Index</A> contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.</BLOCKQUOTE>
 148 <H3>
 149 Prev/Next</H3>
 150 These links take you to the next or previous class, interface, package, or related page.<H3>
 151 Frames/No Frames</H3>
 152 These links show and hide the HTML frames.  All pages are available with or without frames.
 153 <P>
 154 <H3>
 155 Serialized Form</H3>
 156 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.
 157 <P>
 158 <H3>
 159 Constant Field Values</H3>
 160 The <a href="constant-values.html">Constant Field Values</a> page lists the static final fields and their values.
 161 <P>
 162 <FONT SIZE="-1">
 163 <EM>
 164 This help file applies to API documentation generated using the standard doclet.</EM>
 165 </FONT>
 166 <BR>
 167 <HR>
 168
 169
 170 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 171 <A NAME="navbar_bottom"><!-- --></A>
 172 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
 173 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 174 <TR>
 175 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 176 <A NAME="navbar_bottom_firstrow"><!-- --></A>
 177 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 178   <TR ALIGN="center" VALIGN="top">
 179   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 180   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Package</FONT>&nbsp;</TD>
 181   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
 182   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Use</FONT>&nbsp;</TD>
 183   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="overview-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 184   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 185   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 186   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Help</B></FONT>&nbsp;</TD>
 187   </TR>
 188 </TABLE>
 189 </TD>
 190 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 191 </EM>
 192 </TD>
 193 </TR>
 194
 195 <TR>
 196 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 197 &nbsp;PREV&nbsp;
 198 &nbsp;NEXT</FONT></TD>
 199 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 200   <A HREF="index.html?help-doc.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 201 &nbsp;<A HREF="help-doc.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 202 &nbsp;<SCRIPT type="text/javascript">
 203   <!--
 204   if(window==top) {
 205     document.writeln('<A HREF="allclasses-noframe.html"><B>All Classes</B></A>');
 206   }
 207   //-->
 208 </SCRIPT>
 209 <NOSCRIPT>
 210   <A HREF="allclasses-noframe.html"><B>All Classes</B></A>
 211 </NOSCRIPT>
 212
 213
 214 </FONT></TD>
 215 </TR>
 216 </TABLE>
 217 <A NAME="skip-navbar_bottom"></A>
 218 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 219
 220 <HR>
 221
 222 </BODY>
 223 </HTML>