Java API

Java アプリケーション プログラミング インターフェース

ユーザ ガイド

APIの構成

APIには3つのレベルがあります:

レベル 1 - すべてのパッケージ

このレベルのAPIは、1.0 でリリースされたパッケージへのリンクで供給されます

レベル 2 - このパッケージ

このレベルは、このパッケージのクラスとインターフェースへのリンクにより供給されます。3つのカテゴリを以下に示します。

レベル 3 - この クラス/インターフェース

このレベルは、APIの詳細に従ったインデックスではじまります。 3つのカテゴリがクラスレベルにはあります。 カテゴリは、クラスに適当なエンティティがないときは省略されます。

これらのカテゴリ中には、次のようなコードが追加されます :

インスタンス変数
スタティック変数
コンストラクタ
インスタンスメソッド
スタティックメソッド

項目の検出方法

Class-Level APIの詳しい比較検討

java.lang パッケージのStringクラスを見てください。 ナビゲーショナルリンクは一番上にあります。 これは、修飾されたクラス名とクラス構造の中での位置づけの説明となっています。

つぎのエンティティは(もしあるとすれば)、スーパークラスとインターフェースへのリンクとなっています。 これは、クラスの注釈からとったクラスの説明文となっています。 どのようにしてプログラマがHTMLのタグを使用してサンプルのコードからはめ込んでいるかを注意してください。

”参照”エンティティから他のクラスを選ぶこともできます。 クラスレベルのエンティティとして、”参照”、”バージョン”、”著者”がインデックスの始まりとしてあります。

The Index

それぞれのクラス/インターフェースは、アルファベット順のソートされた変数、コンストラクタ、メソッドの インデックスではじまります。 エンティティは宣言と簡単な説明により構成されています。 文はそのアイテムのドキュメントの最初の注釈文と なっています。 インデックスのエンティティは、アプリケーションプログラムのインターフェースへのエンティティと一致するようにリンクされています。

APIの詳細

インデックスは、各エンティティへの完全なAPIにより成っています。 3つのカテゴリ:変数、コンストラクタ、メソッドによって、エンティティはソースのなかで現れる順序で表示されています。 これは、プログラマにより論理的に分類して確立されたものをもとにしています。

APIへのすべてのリンクの場所


本マニュアルに関する著作権および商標