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

この API（Application Program Interface）ドキュメントには、次に説明するナビゲーション・バーの各項目に対応するページが含まれています。

概要

「概要」ページはこのAPIドキュメントの先頭ページで、全パッケージのリストをそれぞれの概要とともに示してあります。 このページには、パッケージ・セットの説明も含まれています。

パッケージ

各パッケージには、その中に含まれているクラスとインタフェースをリストしたページがあり、それぞれの概要が説明されています。 このページには、次の4つのカテゴリが含まれています。

• インタフェース（イタリック表記）
• クラス
• 例外
• エラー

クラス/インタフェース

クラス、インタフェース、内部クラスおよび内部インタフェースには、それぞれ別々のページが用意されています。 このページには次のように、クラスまたはインタフェースの説明、概要表、およびメンバーの詳細説明が含まれます。

• クラス継承図
• 直接のサブクラス
• 既知のサブインタフェースの一覧
• 既知の実装クラスの一覧
• クラス/インタフェースの宣言
• クラス/インタフェースの説明

• 内部クラスの概要
• フィールドの概要
• コンストラクタの概要
• メソッドの概要

• フィールドの詳細
• コンストラクタの詳細
• メソッドの詳細

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

ツリー（クラス階層）

すべてのパッケージが含まれた「クラス階層」ページと、各パッケージごとの階層ページがあります。 各階層ページには、クラスの一覧とインタフェースの一覧が含まれています。 クラスは、java.lang.Objectから始まる継承構造別に編成されています。 インタフェースはjava.lang.Objectからは継承されません。

• 「概要」ページを表示して「ツリー」をクリックすると、すべてのパッケージの階層が表示されます。
• 特定のパッケージ、クラスまたはインタフェースのページを表示して「ツリー」をクリックすると、そのパッケージのみの階層が表示されます。

推奨されないAPI

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

インデックス

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

前/次

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

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

この2つのリンクにより、HTMLフレームの表示および非表示を選択できます。すべてのページは、フレームありおよびフレームなしの両方で表示できます。

直列化された形式

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

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