この API ドキュメントの構成

概要

概要ページは、この API ドキュメントの最初のページであり、すべてのパッケージのリストとそれぞれの概要が表示されます。このページには、パッケージのセットの全体的な説明を含めることもできます。

パッケージ

各パッケージには、クラスとインターフェースのリストとそれぞれの概要を含むページがあります。これらのページには、次の 6 つのカテゴリが含まれる場合があります。

• インターフェース
• クラス
• 列挙型
• 例外
• エラー
• アノテーション型

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

各クラス、インターフェース、ネストされたクラス、ネストされたインターフェースには、個別のページがあります。これらの各ページには、クラス / インターフェースの説明、概要テーブル、詳細なメンバーの説明で構成される 3 つのセクションがあります。

• クラス継承ダイアグラム
• 直属のサブクラス
• すべての既知のサブインターフェース
• すべての既知の実装クラス
• クラスまたはインターフェースの宣言
• クラスまたはインターフェースの説明

• ネストされたクラスのサマリー
• フィールドサマリー
• プロパティのサマリー
• コンストラクターのサマリー
• 方法の概要

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

各サマリーエントリには、そのアイテムの詳細な説明の最初の文が含まれています。サマリーエントリはアルファベット順ですが、詳細な説明はソースコードに表示される順序です。これにより、プログラマーによって確立された論理グループが保持されます。

アノテーション型

各アノテーション型には、次のセクションを持つ独自の個別のページがあります。

• アノテーション型の宣言
• アノテーション型の説明
• 必須定数のサマリー
• オプション要素のサマリー
• 要素の詳細

列挙型

各列挙には、次のセクションを含む独自の個別のページがあります。

• 列挙型の宣言
• 列挙型の説明
• 列挙定数のサマリー
• 列挙定数の詳細

使用

ドキュメント化された各パッケージ、クラス、インターフェースには、独自の使用ページがあります。このページでは、特定のクラスまたはパッケージの一部を使用するパッケージ、クラス、メソッド、コンストラクター、フィールドについて説明します。クラスまたはインターフェース A を指定すると、その " 使用 " ページには、A のサブクラス、A として宣言されたフィールド、A を返すメソッド、型 A のパラメーターを持つメソッドとコンストラクターが含まれます。このページにアクセスするには、最初にパッケージ、クラスに移動します。またはインターフェースを選択し、ナビゲーションバーの 使用 リンクをクリックします。

ツリー (クラス階層)

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

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

非推奨の API

非推奨の API ページには、廃止されたすべての API がリストされています。廃止された API は、一般的に改善のため、使用することはお勧めできません。通常、代替 API が提供されます。非推奨の API は、将来の実装で削除される可能性があります。

インデックス

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

すべてのクラス

すべてのクラスリンクには、非静的ネスト型を除くすべてのクラスとインターフェースが表示されます。

直列化された形式

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

定数フィールド値

定数フィールド値ページには、静的 final フィールドとその値がリストされています。

検索

名前の一部またはすべてを使用して、API で定義されているモジュール、パッケージ、型、フィールド、メソッド、その他の用語の定義を検索できます。「キャメルケース」の略語がサポートされています。たとえば、"InpStr" は "InputStream" と "InputStreamReader" を検索します。