API ドキュメントの構成

概要

概要 ページは API ドキュメントのフロントページで、各パッケージの概要を含む全パッケージの一覧が表示されます。一連のパッケージの概要説明も表示されます。

パッケージ

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

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

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

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

• クラス階層表示
• 直系のサブクラス
• 既知のサブインタフェースの一覧
• 既知の実装クラスの一覧
• クラスまたはインタフェースの宣言
• クラスまたはインタフェースの記述

• 入れ子のクラスの概要
• フィールドの概要
• コンストラクタの概要
• メソッドの概要

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

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

注釈型

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

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

列挙型

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

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

使用

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

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

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

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

推奨されていない API

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

索引

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

前/次

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

直列化された形式

定数フィールド値

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