|PREV NEXT||FRAMES NO FRAMES|
The Overviewpage is the front page of this API document and provides a list of allpackages with a summary for each. This page can also contain an overalldescription of the set of packages.
Each package has a page that contains a list of its classes andinterfaces, with a summary for each. This page can contain fourcategories:
- Interfaces (italic)
- Annotation Types
Each class, interface, nested class and nested interface has its ownseparate page. Each of these pages has three sections consisting of aclass/interface description, summary tables, and detailed memberdescriptions:
Each summary entry contains the first sentence from the detaileddescription for that item. The summary entries are alphabetical, whilethe detailed descriptions are in the order they appear in the sourcecode. This preserves the logical groupings established by theprogrammer.
- Class inheritance diagram
- Direct Subclasses
- All Known Subinterfaces
- All Known Implementing Classes
- Class/interface declaration
- Class/interface description
- Nested Class Summary
- Field Summary
- Constructor Summary
- Method Summary
- Field Detail
- Constructor Detail
- Method Detail
Each annotation type has its own separate page with the following sections:
- Annotation Type declaration
- Annotation Type description
- Required Element Summary
- Optional Element Summary
- Element Detail
Each enum has its own separate page with the following sections:
- Enum declaration
- Enum description
- Enum Constant Summary
- Enum Constant Detail
There is a Class Hierarchypage for all packages, plus a hierarchy for each package. Eachhierarchy page contains a list of classes and a list of interfaces. Theclasses are organized by inheritance structure starting with
java.lang.Object. The interfaces do not inherit from
- When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
- When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
The Deprecated APIpage lists all of the parts of the API that have been deprecated. A deprecated APIis not recommended for use, generally due to improvements, and areplacement API is usually given. Deprecated APIs may be removed infuture implementations.
The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
This help file applies to API documentation generated using the standard doclet.