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