API ドキュメントの構成

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

パッケージ 

各パッケージには、そのパッケージの概要とともに、そのパッケージのクラスとインタフェースのリストを含むページがあります。このページには次の 4 つのカテゴリが含まれます。

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

クラス、インタフェース、入れ子クラス、および入れ子インタフェースには、それぞれ個別のページがあります。各ページには、次のようにクラスまたはインタフェースの説明、概要表、およびメンバーの詳細説明の 3 つの節があります。

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

注釈型

注釈型には、それぞれ個別のページと次の節があります。

列挙型

列挙型には、それぞれ個別のページと次の節があります。

階層ツリー (クラス階層)

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

非推奨 API

非推奨 API」ページには、推奨されていないすべての API のリストが表示されます。非推奨 API とは、一般に機能改良によって使用が推奨されなくなった API であり、通常はそれに代わる API が提供されます。非推奨 API は今後の実装で削除される可能性があります。

索引 

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

前/次

これらのリンクは、前または次のクラス、インタフェース、パッケージ、または関連ページに移動するときに使用します。

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

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

直列化された形式

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

定数フィールド値

定数フィールド値」ページには、static final フィールドとその値のリストが表示されます。

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