APIドキュメントの構成
概要
「概要」ページは、このAPIドキュメントのフロント・ページであり、すべてのモジュールのリストにそれぞれのサマリーが表示されます。 このページには、モジュール・セットの全体的な説明を含めることもできます。
モジュール
各モジュールには、パッケージ、他のモジュールへの依存性、およびサービスのリストを含むページがあり、それぞれのサマリーが示されています。 これらのページには、次の3つのカテゴリが含まれる場合があります:
- パッケージ
- モジュール
- サービス
パッケージ
各パッケージには、そのクラスおよびインタフェースのリストと、それぞれのサマリーを含むページがあります。 これらのページには、6つのカテゴリが含まれる場合があります。
- インタフェース
- クラス
- 列挙型
- 例外
- エラー
- 注釈型
クラスまたはインタフェース
各クラス、インタフェース、ネストされたクラス、およびネストされたインタフェースにはそれ自身の個別のページがあります。 これらのページのそれぞれには、クラスまたはインタフェースの説明と、サマリー表、およびメンバーの詳細説明の3つのセクションがあります。
- クラス継承ダイアグラム
- 直系のサブクラス
- 既知のすべてのサブインタフェース
- 既知のすべての実装クラス
- クラスまたはインタフェースの宣言
- クラスまたはインタフェースの説明
- ネストされたクラスのサマリー
- フィールドのサマリー
- プロパティのサマリー
- コンストラクタのサマリー
- メソッドのサマリー
- フィールド詳細
- 資産詳細
- コンストラクタの詳細
- メソッドの詳細
詳細な説明はソース・コードに現れる順ですが、サマリー・エントリはアルファベット順です。 これによって、プログラマが設定した論理的なグループ分けが保持されます。
注釈型
各注釈型には、それ自身の個別のページと次のセクションがあります。
- 注釈型の宣言
- 注釈型の説明
- 必須要素のサマリー
- オプション要素のサマリー
- 要素の詳細
列挙型
各列挙型には、それ自身の個別のページと次のセクションがあります。
- 列挙宣言
- 列挙の説明
- 列挙型定数のサマリー
- 列挙型定数の詳細
使用
各ドキュメント化されたパッケージ、クラスおよびインタフェースにはそれぞれ「使用」ページがあります。 このページには、どのようなパッケージ、クラス、メソッド、コンストラクタ、およびフィールドが、特定のクラスまたはパッケージの一部を使用しているかが記述されています。 クラスまたはインタフェースAを指定すると、その"使用"ページには、Aのサブクラス、Aとして定義されるフィールド、Aを返すメソッド、およびタイプAのパラメータを持つメソッドおよびコンストラクタが含まれます。 このページにアクセスするには、まずそのパッケージ、クラスまたはインタフェースに移動し、ナビゲーション・バーの「使用」リンクをクリックしてください。
ツリー(クラス階層)
すべてのパッケージには「クラス階層」ページがあり、さらに各パッケージの階層があります。 各階層ページは、クラスのリストとインタフェースのリストを含みます。 クラスは、java.lang.Objectから始まる継承構造によって編成されています。 インタフェースはjava.lang.Objectから継承されません。
- 概要ページを表示しているときに「階層ツリー」をクリックすると、全パッケージの階層が表示されます。
- 特定のパッケージ、クラスまたはインタフェース・ページを表示する場合、"ツリー"をクリックすると、そのパッケージのみの階層が表示されます。
非推奨のAPI
「非推奨のAPI」ページは、推奨されていないすべてのAPIのリストを表示します。 非推奨となったAPIは、一般的には短所が原因で使用することはお薦めしません。また、通常は代替APIが提供されます。 非推奨のAPIは、将来の実装では削除される可能性があります。
索引
「索引」には、すべてのクラス、インタフェース、コンストラクタ、メソッドおよびフィールドのアルファベット索引と、すべてのパッケージおよびすべてのクラスのリストが含まれます。
直列化された形式
直列化可能または外部化可能な各クラスには、直列化フィールドとメソッドの説明があります。 この情報は、APIを使用するのではなく、実装するユーザーにとって重要です。 ナビゲーション・バーにはリンクがありませんが、直列化された任意のクラスに移動し、クラスの説明の"関連項目"セクションで"直列化されたフォーム"をクリックすると、この情報にアクセスできます。
定数フィールド値
「定数フィールド値」ページには、static finalフィールドとその値のリストがあります。
検索
モジュール、パッケージ、タイプ、フィールド、メソッド、システム・プロパティ、およびAPIに定義されているその他の用語の定義は、オプションで"camel-case"短縮名を使用して検索できます。 次に例を示します。
j.l.objは"java.lang.Object"と一致InpStrは"java.io.InputStream"と一致HM.cKは"java.util.HashMap.containsKey(Object)と一致
検索機能の詳細は、「Javadoc検索仕様」を参照してください。
このヘルプ・ファイルは、標準docletによって生成されたAPIドキュメントに適用されます。