1*946379e7Schristos<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd"> 2*946379e7Schristos<!--NewPage--> 3*946379e7Schristos<HTML> 4*946379e7Schristos<HEAD> 5*946379e7Schristos<!-- Generated by javadoc on Sat Nov 03 18:12:05 CET 2001 --> 6*946379e7Schristos<TITLE> 7*946379e7Schristos: API Help 8*946379e7Schristos</TITLE> 9*946379e7Schristos<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style"> 10*946379e7Schristos</HEAD> 11*946379e7Schristos<BODY BGCOLOR="white"> 12*946379e7Schristos 13*946379e7Schristos<!-- ========== START OF NAVBAR ========== --> 14*946379e7Schristos<A NAME="navbar_top"><!-- --></A> 15*946379e7Schristos<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> 16*946379e7Schristos<TR> 17*946379e7Schristos<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 18*946379e7Schristos<A NAME="navbar_top_firstrow"><!-- --></A> 19*946379e7Schristos<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> 20*946379e7Schristos <TR ALIGN="center" VALIGN="top"> 21*946379e7Schristos <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD> 22*946379e7Schristos <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 23*946379e7Schristos <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 24*946379e7Schristos <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 25*946379e7Schristos <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Help</B></FONT> </TD> 26*946379e7Schristos </TR> 27*946379e7Schristos</TABLE> 28*946379e7Schristos</TD> 29*946379e7Schristos<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 30*946379e7Schristos</EM> 31*946379e7Schristos</TD> 32*946379e7Schristos</TR> 33*946379e7Schristos 34*946379e7Schristos<TR> 35*946379e7Schristos<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 36*946379e7Schristos PREV 37*946379e7Schristos NEXT</FONT></TD> 38*946379e7Schristos<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 39*946379e7Schristos <A HREF="index.html" TARGET="_top"><B>FRAMES</B></A> 40*946379e7Schristos <A HREF="help-doc.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD> 41*946379e7Schristos</TR> 42*946379e7Schristos</TABLE> 43*946379e7Schristos<!-- =========== END OF NAVBAR =========== --> 44*946379e7Schristos 45*946379e7Schristos<HR> 46*946379e7Schristos<CENTER> 47*946379e7Schristos<H1> 48*946379e7SchristosHow This API Document Is Organized</H1> 49*946379e7Schristos</CENTER> 50*946379e7SchristosThis API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.<H3> 51*946379e7SchristosPackage</H3> 52*946379e7Schristos<BLOCKQUOTE> 53*946379e7Schristos 54*946379e7Schristos<P> 55*946379e7SchristosEach 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> 56*946379e7Schristos<LI>Interfaces (italic)<LI>Classes<LI>Exceptions<LI>Errors</UL> 57*946379e7Schristos</BLOCKQUOTE> 58*946379e7Schristos<H3> 59*946379e7SchristosClass/Interface</H3> 60*946379e7Schristos<BLOCKQUOTE> 61*946379e7Schristos 62*946379e7Schristos<P> 63*946379e7SchristosEach class, interface, inner class and inner 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> 64*946379e7Schristos<LI>Class inheritance diagram<LI>Direct Subclasses<LI>All Known Subinterfaces<LI>All Known Implementing Classes<LI>Class/interface declaration<LI>Class/interface description 65*946379e7Schristos<P> 66*946379e7Schristos<LI>Inner Class Summary<LI>Field Summary<LI>Constructor Summary<LI>Method Summary 67*946379e7Schristos<P> 68*946379e7Schristos<LI>Field Detail<LI>Constructor Detail<LI>Method Detail</UL> 69*946379e7SchristosEach 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> 70*946379e7Schristos<H3> 71*946379e7SchristosTree (Class Hierarchy)</H3> 72*946379e7Schristos<BLOCKQUOTE> 73*946379e7SchristosThere 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> 74*946379e7Schristos<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> 75*946379e7Schristos</BLOCKQUOTE> 76*946379e7Schristos<H3> 77*946379e7SchristosDeprecated API</H3> 78*946379e7Schristos<BLOCKQUOTE> 79*946379e7SchristosThe <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> 80*946379e7Schristos<H3> 81*946379e7SchristosIndex</H3> 82*946379e7Schristos<BLOCKQUOTE> 83*946379e7SchristosThe <A HREF="index-all.html">Index</A> contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.</BLOCKQUOTE> 84*946379e7Schristos<H3> 85*946379e7SchristosPrev/Next</H3> 86*946379e7SchristosThese links take you to the next or previous class, interface, package, or related page.<H3> 87*946379e7SchristosFrames/No Frames</H3> 88*946379e7SchristosThese links show and hide the HTML frames. All pages are available with or without frames. 89*946379e7Schristos<P> 90*946379e7Schristos<H3> 91*946379e7SchristosSerialized Form</H3> 92*946379e7SchristosEach 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. 93*946379e7Schristos<P> 94*946379e7Schristos<FONT SIZE="-1"> 95*946379e7Schristos<EM> 96*946379e7SchristosThis help file applies to API documentation generated using the standard doclet. </EM> 97*946379e7Schristos</FONT> 98*946379e7Schristos<BR> 99*946379e7Schristos<HR> 100*946379e7Schristos 101*946379e7Schristos<!-- ========== START OF NAVBAR ========== --> 102*946379e7Schristos<A NAME="navbar_bottom"><!-- --></A> 103*946379e7Schristos<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> 104*946379e7Schristos<TR> 105*946379e7Schristos<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 106*946379e7Schristos<A NAME="navbar_bottom_firstrow"><!-- --></A> 107*946379e7Schristos<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> 108*946379e7Schristos <TR ALIGN="center" VALIGN="top"> 109*946379e7Schristos <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD> 110*946379e7Schristos <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 111*946379e7Schristos <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 112*946379e7Schristos <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 113*946379e7Schristos <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Help</B></FONT> </TD> 114*946379e7Schristos </TR> 115*946379e7Schristos</TABLE> 116*946379e7Schristos</TD> 117*946379e7Schristos<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 118*946379e7Schristos</EM> 119*946379e7Schristos</TD> 120*946379e7Schristos</TR> 121*946379e7Schristos 122*946379e7Schristos<TR> 123*946379e7Schristos<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 124*946379e7Schristos PREV 125*946379e7Schristos NEXT</FONT></TD> 126*946379e7Schristos<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 127*946379e7Schristos <A HREF="index.html" TARGET="_top"><B>FRAMES</B></A> 128*946379e7Schristos <A HREF="help-doc.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD> 129*946379e7Schristos</TR> 130*946379e7Schristos</TABLE> 131*946379e7Schristos<!-- =========== END OF NAVBAR =========== --> 132*946379e7Schristos 133*946379e7Schristos<HR> 134*946379e7Schristos 135*946379e7Schristos</BODY> 136*946379e7Schristos</HTML> 137