How This API Document Is Organized
This API (Application Programming Interface) document has pages corresponding
to the items in the navigation bar, described as follows. Package
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:
- Interfaces (italic)
Each 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:
Tree (Class Hierarchy)
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.
- Class inheritance diagram
- Direct Subclasses
- All Known Subinterfaces
- All Known Implementing Classes
- Class/interface declaration
- Class/interface description
- Inner Class Summary
- Field Summary
- Constructor Summary
- Method Summary
- Field Detail
- Constructor Detail
- Method Detail
There is a Class Hierarchy 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
java.lang.Object. The interfaces do not
- 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 Index contains an alphabetic list
of all classes, interfaces, constructors, methods, and fields.
Prev/NextThese links take you to the next or previous class, interface, package,
or related page. Frames/No FramesThese links show and hide the HTML frames. All
pages are available with or without frames. Serialized FormEach 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. This help file applies to API documentation
generated using the standard doclet.