This Javadoc-generated API (Application Programming Interface) documentation includes pages corresponding to the items in the navigation bar—some of which may be absent, depending on the configuration options specified—as described below.
The Overview 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.
Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain up to six categories:
This section actually represents classes (including exceptions and errors), interfaces, enums, and annotation types. Grouping them by title is done for simplicity. The specific page contents for each of these programmatic elements is detailed below.
Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections:
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.
Each enum has its own separate page with the following sections:
Each annotation type has its own separate page with the following sections:
Each documented package, class, and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package.
There is an inheritance hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. Classes are organized by inheritance structure starting with java.lang.Object
; interfaces do not inherit from java.lang.Object
.
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. Deprecated APIs may be removed in future implementations.
The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
The page you're currently viewing.
These links show and hide the HTML frames. All pages are available with or without frames.
These links take you to the next or previous class, interface, package, index letter, or other related page.
Many pages include links to items on the same page (such as summaries and details for packages, classes, methods, etc.) or to related pages (such as for a multi-page index). These links are organized together to simplify navigation.
The Constant Field Values page lists the static final
fields and their values. You can get to this page by going to any static final field and clicking "Constant Field Values" in the "See Also" section of the field description.
The Serialized Form page has a description of serialization fields and methods for each serializable or externalizable class. This information is of interest to re-implementors, not to developers using the API. You can get to this page by going to any serialized class and clicking "Serialized Form" in the "See Also" section of the class description.