APIドキュメントの構成

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

パッケージ

各パッケージには、そのパッケージのクラスおよびインタフェースのリストと、それぞれの概要を含むページがあります。これらのページは6つのカテゴリで構成されます。

• インタフェース
• クラス
• 列挙
• 例外
• エラー
• 注釈型

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

各クラス、インタフェース、ネストされたクラスおよびネストされたインタフェースには個別のページがあります。各ページには次のように、クラスまたはインタフェースの説明と、概要表およびメンバーの詳細説明が含まれます。

• クラス階層表示
• 直系のサブクラス
• 既知のサブインタフェースのリスト
• 既知の実装クラスのリスト
• クラスまたはインタフェースの宣言
• クラスまたはインタフェースの説明

• ネストされたクラスの概要
• フィールドの概要
• プロパティの概要
• コンストラクタの概要
• メソッドの概要

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

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

注釈型

各注釈型には、それ自身の個別のページと次のセクションがあります:

• 注釈型の宣言
• 注釈型の説明
• 必須要素の概要
• 任意要素の概要
• 要素の詳細

列挙

各列挙型には、それ自身の個別のページと次のセクションがあります:

• 列挙宣言
• 列挙型の説明
• 列挙型定数の概要
• 列挙型定数の詳細

使用

各ドキュメント化されたパッケージ、クラスおよびインタフェースにはそれぞれ「使用」ページがあります。このページには、どのようなパッケージ、クラス、メソッド、コンストラクタおよびフィールドが、特定のクラスまたはパッケージの一部を使用しているかが記述されています。たとえば、クラスAまたはインタフェースAの場合、その「使用」ページには、Aのサブクラス、Aとして宣言されるフィールド、Aを返すメソッドと、型Aを持つメソッドおよびコンストラクタが含まれます。このページにアクセスするには、まずそのパッケージ、クラスまたはインタフェースに移動し、ナビゲーション・バーの「使用」リンクをクリックしてください。

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

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

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

推奨されていないAPI

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

索引

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

すべてのクラス

すべてのクラスリンクには、すべてのクラスおよびインタフェース(非staticのネストされた型を除く)が表示されます。

直列化された形式

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

定数フィールド値

定数フィールド値ページには、static finalフィールドとその値のリストがあります。

検索

モジュール、パッケージ、タイプ、フィールド、メソッド、およびAPIで定義されているその他の語を、名前の一部または全体を使用して検索できます。キャメルケースの省略形がサポートされています: たとえば、"InpStr"と指定すると"InputStream"と"InputStreamReader"が検索されます。

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