JavaDoc ヘルプ
ナビゲーション
概要ページから、各ページのリンクと各ページの上部にあるナビゲーションバーを使用してドキュメントを参照できます。インデックスと検索ボックスを使用すると、すべてのパッケージ、すべてのクラスとインターフェースなどの特定の宣言と要約ページに移動できます。検索
名前の一部または全部、オプションで "camelCase" の略語を使用して、API で定義されているモジュール、パッケージ、型、フィールド、メソッド、システムプロパティ、その他の用語の定義を検索できます。例:
j.l.obj
は "java.lang.Object" と一致しますInpStr
は "java.io.InputStream" と一致しますHM.cK
は "java.util.HashMap.containsKey(Object)" と一致します
検索機能の詳細については、Javadoc 検索仕様SEを参照してください。
ページの種類
次のセクションでは、このコレクションのさまざまな種類のページについて説明します。概要
概要ページは、この API ドキュメントのフロントページであり、すべてのパッケージのリストとそれぞれの概要を提供します。このページには、パッケージセットの全体的な説明を含めることもできます。
パッケージ
各パッケージには、クラスとインターフェースのリストとそれぞれの概要を含むページがあります。これらのページには、次のカテゴリが含まれる場合があります。
- インターフェース
- クラス
- 列挙クラス
- 例外
- エラー
- アノテーションインターフェース
クラスまたはインターフェース
各クラス、インターフェース、ネストされたクラス、ネストされたインターフェースには、独自の個別のページがあります。これらの各ページには、宣言と説明、メンバーの概要表、詳細なメンバーの説明で構成される 3 つのセクションがあります。これらの各セクションのエントリは、空であるか該当しない場合は省略されます。
- クラス継承ダイアグラム
- 直属のサブクラス
- すべての既知のサブインターフェース
- すべての既知の実装クラス
- クラスまたはインターフェースの宣言
- クラスまたはインターフェースの説明
- ネストされたクラスのサマリー
- 列挙定数のサマリー
- フィールドサマリー
- プロパティのサマリー
- コンストラクターのサマリー
- メソッドのサマリー
- 必須定数のサマリー
- オプション要素のサマリー
- 列挙型定数の詳細
- フィールドの詳細
- プロパティの詳細
- コンストラクターの詳細
- メソッドの詳細
- 要素の詳細
Note: アノテーションインターフェースには必須要素とオプション要素がありますが、メソッドはありません。列挙型クラスのみが列挙型定数を持っています。レコードクラスのコンポーネントは、レコードクラスの宣言の一部として表示されます。プロパティは JavaFX の機能です。
要約エントリはアルファベット順ですが、詳細な説明はソースコードに表示されている順序になっています。これにより、プログラマーによって確立された論理グループが保持されます。
その他のファイル
パッケージとモジュールには、近くの宣言に関連する追加情報を含むページが含まれている場合があります。
使用
ドキュメント化されたパッケージ、クラス、インターフェースには、それぞれ使用ページがあります。このページではパッケージ、クラス、メソッド、コンストラクター、フィールドが特定のクラスやパッケージのどの部分を使用しているかを説明します。クラスやインターフェース A がある場合、その使用ページには A のサブクラス、A として宣言されたフィールド、A を返すメソッド、型 A のパラメーターを持つメソッドやコンストラクターが含まれます。このページにアクセスするには、まずパッケージ、クラス、インターフェースに移動し、ナビゲーションバーにある使用リンクをクリックします。
ツリー (クラス階層)
すべてのパッケージにクラス階層ページがあり、さらに各パッケージに階層があります。各階層ページには、クラスのリストとインターフェースのリストが含まれています。クラスは、java.lang.Object
で始まる継承構造によって編成されます。インターフェースは java.lang.Object
から継承しません。
- 概要ページを表示しているときにツリーをクリックすると、すべてのパッケージの階層が表示されます。
- 特定のパッケージ、クラス、インターフェースページを表示しているときに、TREE をクリックすると、そのパッケージのみの階層が表示されます。
非推奨の API
非推奨の API ページには、廃止されたすべての API が一覧表示されます。非推奨の API は、一般的に欠点があるため、使用をお勧めしません。通常、代替 API が提供されます。非推奨の API は、将来の実装で削除される可能性があります。
定数フィールド値
定数フィールド値ページには、静的 final フィールドとその値がリストされています。
直列化された形式
直列化可能または外部化可能な各クラスには、その直列化フィールドとメソッドの説明があります。この情報は、API を使用するのではなく実装する人にとって興味深いものです。ナビゲーションバーにリンクはありませんが、直列化されたクラスに移動し、クラスの説明の関連項目セクションにある直列化されたフォームをクリックすると、この情報にアクセスできます。
すべてのパッケージ
すべてのパッケージページには、ドキュメントに含まれるすべてのパッケージのアルファベット順のインデックスが含まれています。
すべてのクラスとインターフェース
すべてのクラスとインターフェースページには、アノテーションインターフェース、列挙型クラス、レコードクラスなど、ドキュメントに含まれるすべてのクラスとインターフェースのアルファベット順のインデックスが含まれています。
インデックス
インデックスには、ドキュメント内のすべてのクラス、インターフェース、コンストラクター、メソッド、フィールドのアルファベット順のインデックスと、すべてのパッケージ、すべてのクラスとインターフェースなどの概要ページが含まれています。
このヘルプファイルは、標準のドックレットによって生成された API ドキュメントに適用されます。