API ドキュメントの編成方法

この API (Application Programming Interface) ドキュメントには、次に説明するナビゲーションバーにある項目に対応するページが含まれます。

パッケージ

各パッケージは、そのパッケージのクラスとインタフェースへのリンクを含むページを持ちます。このページは 4 つのカテゴリで構成されます:

クラスまたはインタフェース

各クラス、インタフェース、内部クラス、および内部インタフェースは個別のページを持ちます。各ページには次のように、クラスまたはインタフェースの説明と、概要テーブル、およびメンバの詳細説明が含まれます:

各概要項目には、その項目の詳細説明の中から 1 行目の文が表示されます。詳細説明はソースコードに現われる順に並びますが、概要項目はアルファベット順に並びます。これによって、プログラマが設定した論理的なグループ分けが保持されます。

ツリー (クラス階層)

すべてのパッケージには クラス階層 ページがあり、さらに各パッケージの階層があります。各階層ページは、クラスのリストとインタフェースのリストを含みます。クラスは java.lang.Object を開始点とする継承構造で編成されます。インタフェースは、java.lang.Object からは継承しません。

推奨されない API

推奨されない API ページは、すべての推奨されない API のリストを表示します。推奨されない API とは、機能改善などによって使用をお勧めできなくなった API のことで、通常はそれに代わる API が提供されます。推奨されない API は今後の実装で削除される可能性があります。

インデックス

インデックス には、すべてのクラス、インタフェース、コンストラクタ、メソッド、およびフィールドのアルファベット順のリストが含まれます。

前/次

これらのリンクにより、前または次のクラス、インタフェース、パッケージ、または関連ページへ移動できます。

フレームあり/フレームなし

これらのリンクは HTML フレームを表示したり隠したりします。すべてのページはフレームありでも、フレームなしでも表示できます。

直列化された形式

直列化可能、または外部化可能な各クラスは、直列化フィールドとメソッドの記述を含みます。この情報は、API を使用する開発者ではなく、再実装の担当者に役立ちます。ナビゲーションバーにリンクがない場合、直列化されたクラスに移動して、クラス記述の [関連項目] セクションにある [直列化された形式] をクリックすることにより、この情報を表示できます。

このヘルプファイルは、標準の doclet によって生成された API ドキュメントに適用されます。