JavaDocヘルプ

ナビゲーション:
- 検索
ページの種類:

概要ページから、各ページおよび各ページの上部にあるナビゲーション・バーでリンクを使用しているドキュメントを参照できます。索引および検索ボックスを使用すると、次を含め、特定の宣言および概要ページにナビゲートできます: すべてのパッケージ, すべてのクラスおよびインタフェース

検索

モジュール、パッケージ、タイプ、フィールド、メソッド、システム・プロパティの定義およびAPIで定義されているその他の語を検索できます。これらのアイテムは、名前の一部または全体を使用して(必要に応じてcamelCaseの省略形を使用して)、または複数の検索語をスペースで区切って検索できます。例をいくつか示します:

"j.l.obj"は"java.lang.Object"に一致します
"InpStr"は"java.io.InputStream"に一致します
"math exact long"は"java.lang.Math.absExact(long)"に一致します

検索機能の詳細な説明は、Javadoc検索仕様を参照してください。

ページの種類

次の各セクションでは、このコレクションの様々な種類のページについて説明します。

概要

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

パッケージ

各パッケージには、そのパッケージのクラスおよびインタフェースのリストと、それぞれの概要を含むページがあります。これらのページは次のカテゴリで構成されます:

インタフェース
クラス
列挙クラス
例外クラス
注釈インタフェース

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

各クラス、インタフェース、ネストされたクラスおよびネストされたインタフェースには個別のページがあります。各ページには次のように、宣言および説明と、メンバーの概要表およびメンバーの詳細説明から構成される3つのセクションが含まれます。これらの各セクションのエントリが空か適用できない場合は省略されます。

クラス階層表示
直系のサブクラス
既知のサブインタフェースのリスト
既知の実装クラスのリスト
クラスまたはインタフェースの宣言
クラスまたはインタフェースの説明

ネストされたクラスの概要
列挙型定数の概要
フィールドの概要
プロパティの概要
コンストラクタの概要
メソッドの概要
必須要素の概要
任意要素の概要

列挙型定数の詳細
フィールド詳細
プロパティの詳細
コンストラクタの詳細
メソッドの詳細
要素の詳細

ノート: 注釈インタフェースには、必須またはオプションの要素が含まれており、メソッドは含まれていません。列挙クラスのみに列挙定数があります。レコード・クラスのコンポーネントがレコード・クラスの宣言の一部として表示されます。プロパティはJavaFXの機能です。

詳細な説明はソース・コードに現れる順に並べられますが、概要エントリはアルファベット順に並べられます。これによって、プログラマが設定した論理的なグループ分けが保持されます。

その他のファイル

パッケージおよびモジュールには、周辺の宣言に関連する追加情報が記載されているページが含まれている場合があります。

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

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

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

推奨されていないAPI

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

定数フィールド値

定数フィールド値ページには、static finalフィールドとその値のリストがあります。

直列化された形式

直列化可能または外部化可能な各クラスは、直列化フィールドとメソッドの説明を含みます。この情報は、APIを使用するのではなく、実装するユーザーに役立ちます。ナビゲーション・バーにリンクがない場合、直列化されたクラスに移動して、クラス記述の「関連項目」セクションにある「直列化された形式」をクリックすることにより、この情報を表示できます。

すべてのパッケージ

すべてのパッケージページには、ドキュメントに含まれるすべてのパッケージのアルファベット順の索引が含まれます。

すべてのクラスおよびインタフェース

すべてのクラスおよびインタフェースには、注釈インタフェース、列挙クラスおよびレコード・クラスなど、ドキュメントに含まれるすべてのクラスおよびインタフェースのアルファベット順の索引が含まれます。

索引

索引には、ドキュメント内のすべてのクラス、インタフェース、コンストラクタ、メソッドおよびフィールドのアルファベット順の索引と、すべてのパッケージ, すべてのクラスおよびインタフェースなどの概要ページが含まれます。

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