以下の設定は、 「プラグイン開発」>「API エラーおよび警告」設定ページを使用して行うことができます。
API 問題がプロジェクトのビルド (自動ビルドおよびフルビルド) 中に発生すると、ツールによって、報告される問題のタイプが以下の 3 つのうちの 1 つに分類されます。
また、プロジェクトの「API エラーおよび警告」プロパティー・ページを使用して、問題の重大度をプロジェクト単位で構成することもできます。
オプション |
説明 |
デフォルト |
---|---|---|
サポートされない API Javadoc タグの使用 |
有効にすると、正しく使用されていない API Javadoc タグが API 分析ビルダーによって検査されます。 |
無視 |
指定された実行環境に参照が定義されていません |
有効にすると、バンドルに指定された実行環境に応じて、正しくない可能性のあるシステム・ライブラリーへの参照が、API 分析ビルダーによって検査されます。 |
無視 |
オプション |
説明 |
デフォルト |
---|---|---|
タグが '@noimplement' であるインターフェースを実装 |
有効にすると、タグが付けられているインターフェースの無許可実装が API 分析ビルダーによって検査されます。 |
警告 |
タグが '@noextend' である型を拡張 |
有効にすると、タグが付けられている型を拡張するクラスが、API 分析ビルダーによって検査されます。 |
警告 |
タグが '@noreference' であるフィールドまたはメソッドを参照 |
有効にすると、タグが付けられているメンバーを参照するフィールドおよびメソッドが、API 分析ビルダーによって検査されます。 |
警告 |
タグが '@noinstantiate' であるクラスのインスタンス化を実行 |
API 分析ビルダーは、有効にすると、タグを付けられたクラスがインスタンス化されていないかどうかを検査します。 |
警告 |
タグが '@nooverride' であるメソッドを上書き |
有効にすると、親クラスのタグが付けられているメソッドが、拡張 (上書きされる親の呼び出しによる再実装) または再実装 (上書きされる親の呼び出しなし) によって子クラスで上書きされないことが、API 分析ビルダーによって検査されます。 |
警告 |
オプション |
説明 |
デフォルト |
---|---|---|
非 API クラスを拡張 |
有効にすると、API クラスが 非 API 型を拡張していないかどうかが、API 分析ビルダーによって検査されます。 |
警告 |
非 API インターフェースの実装 |
有効にすると、API クラスが 非 API インターフェースを実装していないかどうかが、API 分析ビルダーによって検査されます。 |
警告 |
非 API 型のフィールド |
有効にすると、API 型であるべき public フィールドまたは protected フィールドが非 API 型になっていないかどうかが、API 分析ビルダーによって検査されます。 |
警告 |
非 API 戻り型のメソッド |
有効にすると、API 型であるべき public メソッドまたは protected メソッドが非 API 戻り型になっていないかどうかが、API 分析ビルダーによって検査されます。 |
警告 |
非 API パラメーター型のメソッド |
有効にすると、API 型であるべき public メソッドまたは protected メソッドが非 API パラメーター型になっていないかどうかが、API 分析ビルダーによって検査されます。 |
警告 |
オプション |
説明 |
デフォルト |
---|---|---|
メジャー・バージョンの追加に起因する場合であっても API の破損を報告する |
有効にすると、バンドルのメジャー・バージョンが既に追加されている場合であっても API 破損の問題が API 分析ビルダーによって報告されます。 |
使用不可 |
オプション |
説明 |
デフォルト |
---|---|---|
API 型が非 API になった |
有効にすると、現行のバンドルで API 型が非 API 型に変更されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
型が削除された |
有効にすると、指定のバンドルで API スコープから API 型が削除されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
API エクスポート型が非 API になった |
有効にすると、現行のバンドルで API 再エクスポート型が非 API 型に変更されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
再エクスポート型が削除された |
有効にすると、指定のバンドルで API スコープから API 再エクスポート型が削除されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
オプション |
説明 |
デフォルト |
---|---|---|
メソッド (実装が必要) が追加された: |
有効にすると、実装する必要がある public メソッドまたは protected メソッドが任意の API 型に追加されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
制限が追加された |
有効にすると、API クラスの API 制限が追加されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
型パラメーターが追加された |
有効にすると、API クラスに型パラメーターが追加されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
スーパーインターフェースの階層が削減された |
有効にすると、API クラスから親インターフェースが削除されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
キーワード 'abstract' が追加された |
有効にすると、API クラスに 'abstract' キーワードが追加されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
キーワード 'final' が追加された |
有効にすると、API クラスに 'final' キーワードが追加されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
注釈、列挙型、またはインターフェースに変換された |
有効にすると、API クラスが注釈、列挙型、またはインターフェースに変更されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
可視性が削減された |
有効にすると、public API クラスが private クラスまたはデフォルト・スコープに変更されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
フィールドが削除された |
有効にすると、API クラスから public フィールドまたは protected フィールドが削除されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
メソッドが削除された |
有効にすると、API クラスから public メソッドまたは protected メソッドが削除されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
コンストラクターが削除された |
有効にすると、API クラスから public コンストラクターまたは protected コンストラクターが削除されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
スーパークラスの階層が削減された |
有効にすると、階層からスーパークラスが削除されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
メンバー・タイプが削除された |
有効にすると、API クラスからメンバー・タイプが削除されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
型パラメーターが削除された |
有効にすると、API クラスから型パラメーターが削除されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
オプション |
説明 |
デフォルト |
---|---|---|
フィールド (インターフェースが '@noimplement' とタグ付けされていない) が追加された (A field (interface not tagged as '@noimplement') has been added) |
有効にすると、API インターフェースに public フィールドが追加されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
メソッド (インターフェースが '@noimplement' とタグ付けされていない) が追加された |
有効にすると、API インターフェースに public メソッドが追加されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
制限が追加された |
有効にすると、API インターフェースの API 制限が追加されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
型パラメーターが追加された |
有効にすると、API インターフェースに型パラメーターが追加されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
クラス、列挙型、または注釈に変換された |
有効にすると、API インターフェースがクラス、列挙型、またはインターフェースに変更されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
スーパーインターフェースの階層が削減された |
有効にすると、API インターフェースの親インターフェースが削除されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
型パラメーターが削除された |
有効にすると、API インターフェースから型パラメーターが削除されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
フィールドが削除された |
有効にすると、API インターフェースから public フィールドが削除されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
メソッドが削除された |
有効にすると、API インターフェースから public メソッドが削除されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
メンバー・タイプが削除された |
有効にすると、API インターフェースからメンバー型が削除されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
オプション |
説明 |
デフォルト |
---|---|---|
スーパーインターフェースの階層が削減された |
有効にすると、API 列挙型から親インターフェースが削除されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
注釈、クラス、またはインターフェースに変換された |
有効にすると、API 列挙型が注釈、クラス、またはインターフェースに変更されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
フィールドが削除された |
有効にすると、API 列挙型から public フィールドが削除されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
列挙型定数が削除された |
有効にすると、API 列挙型から列挙型定数が削除されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
メソッドが削除された |
有効にすると、API 列挙型から public メソッドが削除されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
メンバー・タイプが削除された |
有効にすると、API 列挙型からメンバー型が削除されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
オプション |
説明 |
デフォルト |
---|---|---|
デフォルト値を持たないメソッドが追加された |
有効にすると、デフォルト値を持たないメソッドが API 注釈に追加されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
クラス、列挙型、またはインターフェースに変換された |
有効にすると、API 注釈がクラス、列挙型、またはインターフェースに変換されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
フィールドが削除された |
有効にすると、API 注釈から public フィールドが削除されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
メソッドが削除された |
有効にすると、API 注釈から public メソッドが削除されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
メンバー・タイプが削除された |
有効にすると、API 注釈から public メンバー・タイプが削除されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
オプション |
説明 |
デフォルト |
---|---|---|
定数値が追加された |
有効にすると、API 型の事前に初期化されていない public フィールドまたは protected フィールドに定数値が追加されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
型が変更された |
有効にすると、API 型の public フィールドまたは protected フィールドの型が変更されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
定数値が変更された |
有効にすると、API 型の public フィールドまたは protected フィールドの定数値が変更されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
可視性が削減された |
有効にすると、API 型の public フィールドまたは protected フィールドが private フィールドに変更されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
静的定数のキーワード 'final' が削除された |
有効にすると、API 型の public フィールドまたは protected フィールドから final キーワードが削除されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
キーワード 'final' が追加された |
有効にすると、API 型の public フィールドまたは protected フィールドに final キーワードが追加されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
キーワード 'static' が削除された |
有効にすると、API 型の public フィールドまたは protected フィールドから static キーワードが削除されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
キーワード 'static' が追加された |
有効にすると、API 型の public フィールドまたは protected フィールドに static キーワードが追加されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
定数値が削除された |
有効にすると、API 型の public フィールドまたは protected フィールドの定数の値が削除されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
型引数が削除された |
有効にすると、API 型の public フィールドまたは protected フィールドから型引数が削除されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
オプション |
説明 |
デフォルト |
---|---|---|
@nooverride 制限が追加された |
有効にすると、API 型で @nooverride タグを追加することにより、public メソッドまたは protected メソッドの制限が変更されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
型パラメーターが追加された |
有効にすると、API 型の public メソッドまたは protected メソッドに型パラメーターが追加されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
変数の引数型が配列型に変換された |
有効にすると、可変引数が API 型の public メソッドまたは protected メソッドのオブジェクト配列に拡張されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
可視性が削減された |
有効にすると、API 型の public メソッドまたは protected メソッドが private メソッドに変更されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
キーワード 'abstract' が追加された |
有効にすると、API 型の public メソッドまたは protected メソッドが abstract メソッドに変更されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
キーワード 'static' が追加された |
有効にすると、API 型の public メソッドまたは protected メソッドが static メソッドに変更されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
キーワード 'static' が削除された |
有効にすると、API 型の public メソッドまたは protected メソッドが非 static メソッドに変更されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
キーワード 'final' が追加された (型が '@noextend' とタグ付けされたもの) |
有効にすると、@noextend とタグ付けされている API 型の public メソッドまたは protected メソッドが final メソッドに変更されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
注釈のデフォルト値が削除された |
有効にすると、API 注釈メソッドに関連したデフォルト値が削除されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
型パラメーターが削除された |
有効にすると、API 型の public メソッドまたは protected メソッドから型パラメーターが削除されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
オプション |
説明 |
デフォルト |
---|---|---|
型パラメーターが追加された |
有効にすると、API 型の public コンストラクターに型パラメーターが追加されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
変数の引数型が配列型に変換された |
有効にすると、可変パラメーターが API 型の public コンストラクターのオブジェクト配列に拡張されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
可視性が削減された |
有効にすると、API 型の public コンストラクターが非 public コンストラクターに変更されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
型パラメーターが削除された |
有効にすると、API 型の public コンストラクターから型パラメーターが削除されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
オプション |
説明 |
デフォルト |
---|---|---|
クラス制約が追加された |
有効にすると、API 型の型パラメーターにクラス制約が追加されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
インターフェース制約が追加された |
有効にすると、API 型の型パラメーターにインターフェース制約が追加されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
クラス制約が変更された |
有効にすると、API 型の型パラメーターでクラス制約が変更されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
インターフェース制約が変更された |
有効にすると、API 型の型パラメーターでインターフェース制約が変更されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
クラス制約が削除された |
有効にすると、API 型の型パラメーターからクラス制約が削除されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
インターフェース制約が削除された |
有効にすると、API 型の型パラメーターからインターフェース制約が削除されたかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
オプション |
説明 |
デフォルト |
---|---|---|
欠落した '@since' タグのレポート |
有効にすると、このバージョンの API ベースラインが使用されるようになってから追加された型またはメンバーの @since タグが欠落していないかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
誤った形式の '@since' タグのレポート |
有効にすると、現在使用されている @since タグが誤った形式 (不正な構文) ではないかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
無効な '@since' タグ・バージョンのレポート |
有効にすると、現在使用されている @since タグのバージョンが誤っていないかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
非互換バンドル・バージョンのレポート |
有効にすると、API の変更および現在使用されている API ベースラインに基づいて、プラグインのバンドル・バージョンが誤っていないかどうかが、API 分析ビルダーによって検査されます。 |
エラー |
API 変更のないマイナー・バージョン増分を無視する |
非互換バージョン番号のレポートを有効にする場合、このオプションを使用すると、現行の API ベースラインと比較して API の変更がなかったときにはマイナー・バージョン変更を無視するよう API 分析ビルダーに通知することができます。 |
オン |
API 変更のないメジャー・バージョン増分を無視する (Ignore major version increment without API changes) |
非互換バージョン番号のレポートを有効にする場合、このオプションを使用すると、現行の API ベースラインと比較して API の変更がなかったときにはメジャー・バージョン変更を無視するように API 分析ビルダーに通知することができます。 |
オン |
オプション |
説明 |
デフォルト |
---|---|---|
バンドルに必須の制約/前提条件の欠落 |
有効にすると、ビルダーが完全な分析を実行するのを妨げる、必須の制約または前提条件の欠落が、API 分析ビルダーによって報告されます。このオプションの値に関係なく、対応するバンドルに対する分析はスキップされます。 |
エラー |
未使用の API 問題フィルター |
有効にすると、使用されていない API 問題フィルターが API 分析ビルダーによって報告されます。 |
警告 |
オプション |
説明 |
デフォルト |
---|---|---|
未解決の型の問題 (Unresolved type problem) |
有効にすると、「API 使用スキャン」設定ページにリストされている任意の使用スキャンにインクルードされているすべての削除済み API の型が、API 分析ビルダーによって報告されます。 |
エラー |
未解決のメソッドの問題 (Unresolved method problem) |
有効にすると、「API 使用スキャン」設定ページにリストされている任意の使用スキャンにインクルードされているすべての削除済みメソッドが API 分析ビルダーによって報告されます。 |
エラー |
未解決のフィールドの問題 (Unresolved field problem) |
有効にすると、「API 使用スキャン」設定ページにリストされている任意の使用スキャンにインクルードされているすべての削除済みフィールドが API 分析ビルダーによって報告されます。 |
エラー |
PDE 設定
「API エラーおよび警告」プロパティー・ページ
API ベースラインの設定
API 使用スキャンに関する設定