JavaDocヘルプ

ナビゲーション

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

ページの種類

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

概要

「概要」ページは、このAPIドキュメントのフロント・ページであり、すべてのモジュールのリストにそれぞれのサマリーが表示されます。 このページには、モジュール・セットの全体的な説明を含めることもできます。

モジュール

各モジュールには、パッケージ、他のモジュールへの依存性、およびサービスのリストを含むページがあり、それぞれのサマリーが示されています。 これらのページには、次のカテゴリがあります:

  • パッケージ
  • モジュール
  • サービス

パッケージ

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

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

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

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

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

  • ネストされたクラスのサマリー
  • 列挙型定数のサマリー
  • フィールドのサマリー
  • プロパティのサマリー
  • コンストラクタのサマリー
  • メソッドのサマリー
  • 必須要素のサマリー
  • オプション要素のサマリー

  • 列挙型定数の詳細
  • フィールド詳細
  • 資産詳細
  • コンストラクタの詳細
  • メソッドの詳細
  • 要素の詳細

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

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

その他のファイル

パッケージおよびモジュールには、付近の宣言に関連する追加情報を含むページが含まれる場合があります。

使用

各ドキュメント化されたパッケージ、クラスおよびインタフェースにはそれぞれ「使用」ページがあります。 このページには、どのようなパッケージ、クラス、メソッド、コンストラクタ、およびフィールドが、特定のクラスまたはパッケージの一部を使用しているかが記述されています。 たとえば、クラスAまたはインタフェースAの場合、その「使用」ページには、Aのサブクラス、Aとして宣言されるフィールド、Aを返すメソッドと、型Aのパラメータを持つメソッドおよびコンストラクタが含まれます。 このページにアクセスするには、まずパッケージ、クラスまたはインタフェースに移動し、ナビゲーション・バーのUSEリンクをクリックします。

ツリー(クラス階層)

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

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

APIのプレビュー

「APIのプレビュー」ページには、すべてのプレビューAPIがリストされます。 プレビューAPIは、将来の実装で削除される可能性があります。

新規API

「新規API」ページには、最近のリリースで追加されたAPIがリストされます。

非推奨のAPI

「非推奨のAPI」ページは、推奨されていないすべてのAPIのリストを表示します。 非推奨となったAPIは、一般的には短所が原因で使用することはお薦めしません。また、通常は代替APIが提供されます。 非推奨のAPIは、将来の実装では削除される可能性があります。

定数フィールド値

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

直列化された形式

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

システム・プロパティ

「システム・プロパティ」ページには、システム・プロパティへの参照がリストされます。

すべてのパッケージ

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

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

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

索引

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

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