Java Application Programming Interface
How the API Is OrganizedThere are three levels to the API:
Level 1 - All PackagesThis level of the API provides links to the packages in the 1.0 release.
Level 2 - This PackageThis level provides links to the classes and interfaces in a given package. There are three catogories in the listing:
Level 3 - This Class/InterfaceThis level begins with an index, followed by the detailed API. There are three categories at the class level.
Within these categories there is additional color coding as follows:
How to Locate Items
A Closer Look at the Class-Level APITake a look at class String in the package java.lang. The navigational anchors are at the top. This is followed by the fully qualified class name and a representation of its position in the class hierarchy.
The next entries are links to the superclass and the interfaces, if any. This is followed by a description of the class, taken from the class comment. Notice how the programmer has embedded some code samples using html tags.
The author also chose to include a See Also entry to another class. Following the class-level entries for See Also, Version, and Author, the index begins.
The IndexEach class/interface begins with an index of its variables, constructors and methods, sorted alphabetically. The entry consists of the declaration and short description. The description is the first sentence of the doc comment for that item. The index entries are linked to their corresponding entries in the application programming inteface which immediately follows.
The Detailed APIThe index is followed by the complete API for each entry. Within the three categories: Variables, Constructors, and Methods, the entries are presented in the order they appear in the source. This is done to preserve the logical groupings established by the programmer.
Where Are All the Links in the API?
Submit a bug or feature - Version 1.1.7 of Java Platform API Specification
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.
Copyright 1995-1998 Sun Microsystems, Inc. 901 San Antonio Road,
Palo Alto, California, 94303, U.S.A. All Rights Reserved.
Oracle is reviewing the Sun product roadmap and will provide guidance to customers in accordance with Oracle's standard product communication policies. Any resulting features and timing of release of such features as determined by Oracle's review of roadmaps, are at the sole discretion of Oracle. All product roadmap information, whether communicated by Sun Microsystems or by Oracle, does not represent a commitment to deliver any material, code, or functionality, and should not be relied upon in making purchasing decisions. It is intended for information purposes only, and may not be incorporated into any contract.