Class | Tree | Deprecated | Index | Help
PREV | NEXT	FRAMES | NO FRAMES

How This API Document Is Organized

This API document has an Overview page, a page for each Package, a page for each Class and Interface, plus a set of class hierarchies, a deprecated API list, and an index of API.

Overview

The Overview page is the front page of this API document and provides a list of all packages. To the right of each package name is the first sentence from its package description. This page can also contain an overall description of the set of packages.

Package

Each package has a web page that contains a links to its classes and interfaces. In addition, each class and interface contains the first sentence from the class or interface description. This page can contain four categories:

• Interfaces
• Classes
• Exceptions
• Errors

Class (or Interface)

Each class and interface has a separate "class" web page. Note that each inner class has its own page. Each page contains a class description plus detailed descriptions of each of its inner classes, fields, constructors and methods, as follows:

• Class inheritance diagram - This starts with the topmost class (java.lang.Object) and ends with the class or interface.
• Subclasses - A list of all direct subclasses. (This may change to all direct and indirect subclasses in a later version of javadoc.) Of course, any new subclasses generated outside of this document that someone creates will not appear in this list.
• Implementing Classes - For an interface, a list of all classes that implement it.
• Class declaration
• Class description

• Inner Class Summary
• Field Summary
• Constructor Summary
• Method Summary

• Field Detail
• Constructor Detail
• Method Detail

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.

Tree (Class Hierarchy)

The Class Hierarchy contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces are organized the same, but do not inherit from java.lang.Object.

• If you are viewing the contents page, clicking on "Tree" displays the hierarchy for all packages.
• If you are viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.

Deprecated API

The Deprecated API 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. While deprecated APIs are currently still implemented, they may be removed in future implementations.

The Index contains a list of all classes, interfaces, constructors, methods, and fields.

This help file applies to API documentation generated using the standard doclet.