このAPIドキュメントの構成
-
概要
概要ページは、このAPIドキュメントのトップページであり、すべてのパッケージの一覧をそれぞれの要約とともに提供する。このページには、パッケージ群全体の説明が含まれることもある。
-
パッケージ
各パッケージには、そのクラスとインタフェースの一覧をそれぞれの要約とともに掲載したページがある。これらのページには、次の6つのカテゴリが含まれることがある。
- インタフェース
- クラス
- 列挙型
- 例外
- エラー
- 注釈型
-
クラスまたはインタフェース
各クラス、インタフェース、ネストされたクラス、ネストされたインタフェースには、それぞれ専用のページがある。これらの各ページは、クラス／インタフェースの説明、要約テーブル、メンバーの詳細な説明という3つのセクションで構成される。
- クラス継承図
- 直接のサブクラス
- 既知のすべてのサブインタフェース
- 既知のすべての実装クラス
- クラスまたはインタフェースの宣言
- クラスまたはインタフェースの説明
- ネストされたクラスの要約
- フィールドの要約
- プロパティの要約
- コンストラクタの要約
- メソッドの要約
- フィールドの詳細
- プロパティの詳細
- コンストラクタの詳細
- メソッドの詳細
各要約エントリには、その項目の詳細な説明の最初の文が含まれる。要約エントリはアルファベット順であり、詳細な説明はソースコードに現れる順序で並ぶ。これにより、プログラマが確立した論理的なグループ分けが保たれる。
-
注釈型
各注釈型には、次のセクションを持つ専用のページがある。
- 注釈型の宣言
- 注釈型の説明
- 必須要素の要約
- 省略可能な要素の要約
- 要素の詳細
-
列挙型
各列挙型には、次のセクションを持つ専用のページがある。
- 列挙型の宣言
- Enum の説明
- Enum 定数の概要
- Enum 定数の詳細
-
ツリー (クラス階層)
すべてのパッケージを対象としたクラス階層ページと、パッケージごとの階層がある。各階層ページにはクラスの一覧とインタフェースの一覧が含まれる。クラスは
java.lang.Objectを起点とする継承構造に従って整理されている。インタフェースはjava.lang.Objectを継承しない。- 概要ページを表示しているときに「ツリー」をクリックすると、すべてのパッケージの階層が表示される。
- 特定のパッケージ、クラス、またはインタフェースのページを表示しているときに「ツリー」をクリックすると、そのパッケージのみの階層が表示される。
-
非推奨API
非推奨APIページには、非推奨となったすべてのAPIが一覧表示される。非推奨APIは、一般に機能改善のため使用が推奨されておらず、通常は代替APIが示されている。非推奨APIは将来の実装で削除される可能性がある。
-
索引
索引には、すべてのクラス、インタフェース、コンストラクタ、メソッド、フィールドのアルファベット順索引に加え、すべてのパッケージとすべてのクラスの一覧が含まれる。
-
全クラス
All Classesリンクは、非staticなネスト型を除くすべてのクラスとインタフェースを表示する。
-
直列化された形式
直列化(serializable)または外部化(externalizable)可能な各クラスには、その直列化フィールドとメソッドの説明がある。この情報は、APIを利用する開発者ではなく、再実装する人にとって有用である。ナビゲーションバーにリンクはないが、任意の直列化されたクラスに移動し、そのクラスの説明の「関連項目」セクションで「直列化された形式」をクリックすると、この情報にアクセスできる。
-
定数フィールドの値
定数フィールド値ページには、static finalフィールドとその値が一覧表示される。
-
検索
APIで定義されたモジュール、パッケージ、型、フィールド、メソッド、その他の用語の定義を、名前の一部または全部を使って検索できる。「キャメルケース」の省略形もサポートされている。たとえば「InpStr」と入力すると「InputStream」や「InputStreamReader」が見つかる。
This help file applies to API documentation generated by the standard doclet.