Java Fundamentals (part 8)

Using the Java API Online Documentation

The main source of information as to the various classes, fields, and methods available in the Java language is detailed in the Application Programming Interface (API) documents. These HTML files are arranged hierarchically, so that the home page lists all the packages as hyperlinks. If you select a link, the classes contained in that package are listed. Selecting a class then brings up a description of the class, it’s fields and methods, and links to related classes, methods and fields.

Figure 2 – The Java API Online Documentation

The main sections of a class document are:

• The class hierarchy



• A description of the class and it’s general purpose



• A list of it’s member variables (fields)



• A list of it’s constructors



• A list of it’s methods



• A detailed list of it’s variables with a description



• A detailed list of it’s constructors with a description



• A detailed list of it’s methods with a description

Unfortunately, there aren’t many examples available to demonstrate the syntax. There are general examples available in a separate folder on your hard drive.