API ドキュメントの構成

この API (Application Programming Interface) ドキュメントには、次に説明するナビゲーションバーにある項目に対応するページが含まれます。

パッケージ

各パッケージは、そのパッケージのクラスとインタフェースへのリンクを含むページを持ちます。このページは 4 つのカテゴリで構成されます:

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

各クラス、インタフェース、入れ子クラス、および入れ子インタフェースは個別のページを持ちます。各ページには次のように、クラスまたはインタフェースの説明と、概要テーブル、およびメンバの詳細説明が含まれます:

各概要エントリには、その項目の詳細な記述の中から 1 行目の文が表示されます。詳細な記述はソースコードに現われる順に並べられますが、概要エントリはアルファベット順に並べられます。これによって、プログラマが設定した論理的なグループ分けが保持されます。

注釈型

各注釈型には、それ自身の個別のページと次のセクションがあります:

列挙型

各列挙型には、それ自身の個別のページと次のセクションがあります:

使用

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

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

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

推奨されていない API

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

索引

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

前/次

これらのリンクにより、前または次のクラス、インタフェース、パッケージ、または関連ページへ移動できます。

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

これらのリンクは HTML フレームを表示したり隠したりします。すべてのページはフレームありでも、フレームなしでも表示できます。

直列化された形式

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

定数フィールド値

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

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



本ライブラリは"さかきけい"が作成した無保証の評価目的専用のOBEXライブラリです。他の用途への転用は一切行えません。
記載された内容および本ライブラリには既知か否かに関らず誤りが含まれる可能性があり、一切保証はありません。本APIリファレンスおよび本ライブラリを使用した結果、不利益が生じたとしても"さかきけい"は一切の責任を負いません。
許可無く公開/非公開およびInternet/Intranet/LANを問わず他サイトに転載すること、複写および複製することを禁じます。

Copyright© 2002-2008 by KEI SAKAKI.
ALL RIGHTS RESERVED.
無断転載を禁じます。