API ヘルプ

API ドキュメントの構成

この API(Application Programming Interface)ドキュメントには、ナビゲーション バーの項目に対応する、次のようなページがあります。
  • 概要

    概要ページは、この API ドキュメントのトップページです。パッケージのリストと各パッケージの概要が記載されます。このページには、一連のパッケージの簡単な説明が提示される場合もあります。

  • パッケージ

    各パッケージには、そのクラス、インターフェース、概要をまとめたリストが記載されているページがあります。このページは 6 つのカテゴリを含んでいます。

    • インターフェース(斜体表記)
    • クラス
    • 列挙型
    • 例外
    • エラー
    • アノテーション型
  • クラス / インターフェース

    各クラス、インターフェース、入れ子クラス、入れ子インターフェースについては個別のページが設けられています。これらのページには、クラスとインターフェースの説明、概要テーブル、メンバーの詳細な説明が記載されています。

    • クラスの継承図
    • ダイレクト サブクラス
    • 既知のサブインターフェースの一覧
    • 既知の実装クラス
    • クラス / インターフェースの表示
    • クラス / インターフェース説明
    • ネストクラス概要
    • フィールドの概要
    • コンストラクタの概要
    • メソッドの概要
    • フィールドの詳細
    • コンストラクタの詳細
    • メソッドの詳細

    各概要エントリには、その項目の詳細な説明の 1 行目の文が表示されます。詳細な説明はソースコードに表示されている順に、概要エントリはアルファベット順に記載されています。プログラマーが設定した論理グループを保持しています。

  • アノテーション型

    各アノテーション型については、次のセクションで個別のページが設けられています。

    • アノテーション型の宣言
    • アノテーション型の説明
    • 必須要素の概要
    • オプション要素の概要
    • 要素の詳細
  • 列挙型

    各列挙型については、次のセクションで個別のページが設けられています。

    • 列挙型表示
    • 列挙型の説明
    • 列挙型定数の概要
    • 列挙型定数の詳細
  • ツリー(クラス階層)

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

    • 概要ページを表示するときは、「ツリー」をクリックしてすべてのパッケージの階層を表示します。
    • 特定のパッケージ、クラス、またはインターフェースのページを表示するときは、「ツリー」をクリックしてそのパッケージの階層のみを表示します。
  • サポートが終了した API

    サポート終了 API のページには、サポートが終了したすべての API の一覧が記載されています。サポート終了 API は、主に改善が理由で、現在は使用が推奨されていない API です。通常、代わりとなる API が提供されています。サポート終了 API は今後の実装で削除される可能性があります。

  • インデックス

    インデックスには、すべてのクラス、インターフェース、コンストラクタ、メソッド、フィールドのアルファベット順のリストが含まれています。

  • 前のページ / 次のページ

    このリンクをクリックすると、クラス、インターフェース、パッケージ、または関連ページの前後のページへ移動できます。

  • フレームあり / フレームなし

    このリンクをクリックすると、HTML のフレームの表示 / 非表示を切り替えることができます。すべてのページでフレームありとフレームなしを切り替えることができます。

  • すべてのクラス

    すべてのクラスのリンクをクリックすると、すべてのクラスとインターフェース(非静的でネストされたものを除く)を表示します。

  • シリアル化されたフォーム

    各シリアル化可能クラスまたは外部クラスには、シリアル化フィールドとメソッドの説明があります。この情報は、API を使用するデベロッパーではなく、再実装の担当者向けです。ナビゲーション バーにリンクがない間は、シリアル化されたクラスのいずれかに移動して、クラスの説明が記載された「関連項目」セクション内の「シリアル化されたフォーム」をクリックすることで、この情報を得ることができます。

  • 定数フィールド値

    定数フィールド値ページには、static final フィールドとその値が記載されています。

このヘルプファイルは、標準ドックレットを使用して生成された API ドキュメントに適用されます。
このページは役立ちましたか?評価をお願いいたします。

フィードバックを送信...

Java の App Engine スタンダード環境