この API ドキュメントはどのように構成されているか
-
Overview
概要ページはこの API ドキュメントの先頭ページで、すべてのパッケージのリストとそれぞれの概要が表示されます。 このページには、パッケージのセットの全体的な説明を含めることもできます。
-
パッケージ
各パッケージには、クラスとインターフェースのリストとそれぞれの概要を含む ページがあります。 これらのページには、次の 6 つのカテゴリが含まれる場合があります。
- インターフェース
- クラス
- Enums
- 例外
- Errors
- 注釈のタイプ
-
クラスまたはインターフェース
各クラス、インターフェース、ネストされたクラス、ネストされたインターフェースには、独自のページがあります。 これらの各ページには、クラスまたはインターフェースの説明、概要表、ノードの詳細な説明で構成される 3 つのセクションがあります。
- クラス継承図
- 直接サブクラス
- すべての既知のサブインターフェース
- すべての既知の実装クラス
- クラスまたはインターフェースの宣言
- クラスまたはインターフェースの説明
- ネストされたクラスの概要
- フィールドの概要
- プロパティの概要
- コンストラクターの概要
- メソッドの概要
- フィールドの詳細
- プロパティの詳細
- コンストラクターの詳細
- メソッドの詳細
各サマリーとしてには、そのアイテムの詳細な説明からの最初の文章が含まれています。 概要エントリはアルファベット順で、詳細な説明はソースコードに表示される順序順です。 これにより、プロファイラーによって確立された論理グループが保持されます。
-
注釈タイプ
各注釈型には、次のセクションを含む個別のページがあります。
- 注釈型の宣言
- 注釈タイプの説明
- 必要な要素の概要
- 任意要素の概要
- 要素の詳細
-
列挙
各列挙には、次のセクションを含む個別のページがあります。
- 列挙宣言
- 列挙型の説明
- 列挙定数の概要
- 列挙定数の詳細
-
ツリー（クラス階層）
すべてのパッケージにはクラス階層ページと、各パッケージの階層があります。 各階層ページには、クラスのリストとインターフェースのリストが含まれています。 クラスは
java.lang.Objectから始まる継承構造によって整理されます。 インターフェースはjava.lang.Objectから継承しません。- 概要 ページを表示するときに [ツリー] をクリックすると、すべてのパッケージの階層が表示されます。
- 特定のパッケージ、クラス、またはインターフェースのページを表示するときに [ツリー] をクリックすると、そのパッケージのみの階層が表示されます。
-
非推奨 API
[ 非推奨 API ]ページには、非推奨になったすべての API が一覧表示されます。 非推奨の API は通常、改善により使用することは推奨されず、置換 API が通常提供されます。 非推奨 API は、将来の実装で削除される可能性があります。
-
Index
インデックスには、すべてのクラス、インターフェース、コンストラクター、メソッド、およびフィールドのアルファベット順のインデックスと、すべてのパッケージとすべてのクラスのリストが含まれます。
-
すべてのクラス
[すべてのクラス ]リンクには、静的でないネストされた型を除くすべてのクラスとインターフェースが表示されます。
-
直列化された形式
直列化可能な各クラスまたは外部化可能なクラスには、直列化フィールドとメソッドの説明があります。 この情報は、 API を使用している開発者ではなく、再実装者にとって重要です。 ナビゲーション バーには リンクはありませんが、直列化されたクラスに移動し、クラス説明の「も参照してください」セクションで「Serializedform」をクリックすると、この情報を取得できます。
-
定数フィールド値
[定数フィールド値 ]ページには、静的最終フィールドとその値が一覧表示されます。
-
検索
API で定義されているモジュール、パッケージ、タイプ、フィールド、メソッド、およびその他の用語の定義を検索するには、名前の一部またはすべてを使用します。 「キャメルケース」の省略形がサポートされています。たとえば、"InpStr" では "InputStream" と "In putStreamReader" が検索されます。
このヘルプ ファイルは、標準ドキュメントによって生成された API ドキュメントに適用されます。