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