APIドキュメントの構成

• Navigation:
  • 検索
• Kinds of Pages:
  • 概要
  • パッケージ
  • クラスまたはインタフェース
  • Other Files
  • 使用
  • 階層ツリー(クラス階層)
  • All Packages
  • All Classes and Interfaces
  • 索引

Navigation

Starting from the 概要 page, you can browse the documentation using the links in each page, and in the navigation bar at the top of each page. The 索引 and Search box allow you to navigate to specific declarations and summary pages, including: すべてのパッケージ, All Classes and Interfaces

検索

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

• j.l.objは"java.lang.Object"と一致します
• InpStrは"java.io.InputStream"と一致します
• HM.cKは"java.util.HashMap.containsKey(Object)"と一致します

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

Kinds of Pages

The following sections describe the different kinds of pages in this collection.

概要

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

パッケージ

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

• インタフェース
• クラス
• Enum Classes
• 例外
• エラー
• Annotation Interfaces

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

各クラス、インタフェース、ネストされたクラスおよびネストされたインタフェースには個別のページがあります。各ページには次のように、クラスまたはインタフェースの説明と、概要表およびメンバーの詳細説明が含まれます。

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

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

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

Note: Annotation interfaces have required and optional elements, but not methods. Only enum classes have enum constants. The components of a record class are displayed as part of the declaration of the record class. Properties are a feature of JavaFX.

The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.

Other Files

Packages and modules may contain pages with additional information related to the declarations nearby.

使用

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

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

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

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

All Packages

The すべてのパッケージ page contains an alphabetic index of all packages contained in the documentation.

All Classes and Interfaces

The All Classes and Interfaces page contains an alphabetic index of all classes and interfaces contained in the documentation, including annotation interfaces, enum classes, and record classes.

索引

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

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