概要 | パッケージ | クラス | 階層ツリー | 非推奨 API | 索引 | ヘルプ
openGion 5.5.3.1
前 次 | フレームあり フレームなし

# API ドキュメントの構成

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

### 概要

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

### パッケージ

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

> - インタフェース (イタリック)
> - クラス
> - 列挙型
> - 例外
> - エラー
> - 注釈型

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

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

> - クラス階層表示
> - 直系のサブクラス
> - 既知のサブインタフェースの一覧
> - 既知の実装クラスの一覧
> - クラスまたはインタフェースの宣言
> - クラスまたはインタフェースの記述

> - 入れ子のクラスの概要
> - フィールドの概要
> - コンストラクタの概要
> - メソッドの概要

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

### 注釈型

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

> - 注釈型の宣言
> - 注釈型の説明
> - 必須要素の概要
> - 任意要素の概要
> - 要素の詳細

### 列挙型

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

> - 列挙型の宣言
> - 列挙型の説明
> - 列挙型定数の概要
> - 列挙型定数の詳細

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

> すべてのパッケージには クラス階層 ページがあり、さらに各パッケージの階層があります。各階層ページは、クラスのリストとインタフェースのリストを含みます。クラスは `java.lang.Object` を開始点とする継承構造で編成されます。インタフェースは、`java.lang.Object` からは継承しません。
> - 概要ページを表示しているときに [ツリー] をクリックすると、全パッケージの階層が表示されます。
> - 特定のパッケージ、クラス、またはインタフェースを表示しているときに [ツリー] をクリックすると、該当するパッケージだけの階層が表示されます。

### 推奨されていない API

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

### 索引

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

### 前/次

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

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

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

### 直列化された形式

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

### 定数フィールド値

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

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

概要 | パッケージ | クラス | 階層ツリー | 非推奨 API | 索引 | ヘルプ
| openGion 5.5.3.1
前 次 | フレームあり フレームなし

Webアプリケーションフレームワーク openGion
Copyright (c) 2009 The openGion Project.