Return to API

API Help

How This API Document Is Organized

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

Contents

The contents page is the list of all packages in this document. This page packages.html provides a list of all packages and is the front page of this document. In addition, each entry contains the first sentence from the package description.

Package

There is one package page for each package. Each package page contains a list of links to the classes and interfaces in a given package. In addition, each entry contains the first sentence from the class or interface description. It can contain four categories:

Class (or Interface)

There is a separate "class" page for each class and interface. Note that each inner class has its own page. Each page describes the class and contains detailed descriptions of each of its inner classes, fields, constructors and methods. This page contains: 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 is done to preserve the logical groupings established by the programmer. The categories are as follows (a category is omitted when it has no entries):

Tree (Class Hierarchy)

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

Deprecated API

This page lists all of the API that have been deprecated. A deprecated API is an API that we recommend you no longer use, due to improvements in Java. While deprecated APIs are currently still implemented, they may be removed in future implementations, and we recommend using other APIs. The @deprecated tag denotes a deprecated API. For a description of deprecation, see Deprecation of APIs.

Index

The Index contains a list of all class, interfaces, constructors, methods, and fields. It is internationalized (allows for API names using any Unicode characters), and is sorted alphabetically.

Show Lists / Hide Lists

These links show and hide two HTML frames along the left side of the browser window. One frame contains a list of all packages, while the other contains a list of classes and interfaces in the selected package. When you click "Hide Lists", it merely hides the two left-hand lists. However, when you click on "Show Lists", it displays those lists and also changes the main frame to the contents page (due to a limitation in HTML).

Prev /Next

These links take you to the previous or next appropriate page:

Submit a bug or feature