API 制約の定義

API ツールは、API の使用状況を明示的に文書化および制限するための Javadoc タグを提供します。以下の表では、各メンバーによってサポートされる Javadoc タグおよび各タグのセマンティクスを要約しています。

クライアント とは、関連の API が定義されているバンドルを必要とするプラグインまたはバンドルのことです。制約は、API が定義されているのと同じバンドル内では適用されません。例えば、インターフェースを @noimplement として定義するバンドルは、そのインターフェースの実装を提供することもできます。

サポートされる制約タグ

  クラス インターフェース メソッド コンストラクター

final フィールド

非 final フィールド
@noimplement
-
サポートされる
-
-
-
-
@noextend
サポートされる
サポートされる
-
-
-
-
@noinstantiate
サポートされる
-
-
-
-
-
@nooverride
-
-
サポートされる
-
-
-
@noreference
-
-
サポートされる
サポートされる
-
サポートされる

制約セマンティクス

@noimplement

クライアントがこのインターフェースを実装してはならないことを示します。スーパークラスが実装されていない関連インターフェースまたは関連インターフェースの親に、implements キーワードを使用しているクラスには、問題のフラグが立てられます。

@noextend
クライアントがこのクラスまたはインターフェースを拡張してはならないことを示します。関連する型に extends キーワードを使用しているクラスまたはインターフェースには、問題のフラグが立てられます。
@noinstantiate
クライアントがこのクラスをインスタンス化してはならないことを示します。このクラスをいずれかのコンストラクターでインスタンス化しているコードは、問題のフラグが立てられます。
@nooverride
クライアントがこのメソッドを再宣言してはならないことを示します。このメソッドを上書きするメソッドを定義しているサブクラスは、問題のフラグが立てられます。
@noreference
クライアントがこのメソッド、コンストラクター、または非 final フィールドを参照してはならないことを示します。このメソッドまたはコンストラクターを直接呼び出すか、この非 final フィールドを参照しているコードは、問題のフラグが立てられます。

関連タスク

ベースラインのセットアップ

関連参照

Javadoc @since タグの管理
API ベースラインの設定
API エラーおよび警告に関する設定