How This API Document Is Organized

This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.

Overview

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.

Package

Each package has a page that contains a list of its events, aggregates and monitors, with a summary for each. This page can contain three categories:

Event/Aggregate/Monitor

Each event, aggregate and monitor has its own separate page. Each of these pages has three sections consisting of a event/monitor description, summary tables, and detailed member descriptions:

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. Deprecated APIs may be removed in future implementations.

Frames/No Frames

These links show and hide the HTML frames. All pages are available with or without frames.

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