このタスクは、ベースラインに対して相対的なプロファイル内の API 使用スキャンを解決します。現在プロファイルから欠落しているタイプ、メソッドおよびフィールドへの参照をレポートします。
Ant タスクの名前は、apitooling.apiusescanproblems です。使用するには、jar ファイル apitooling-ant.jar が Ant クラスパス上になければなりません。
<apitooling.apiusescanproblems profile="..." report="..." apiusescans="..." excludelist="..." includelist="..." preferences="..." debug="..." />
| 属性 | 説明 | 必須 |
| profile | この属性は、API 使用スキャンを解決する対象となる現在の製品またはプロファイルのロケーションを指定します。
このロケーションは、.zip、.jar、.tgz、.tar.gz ファイル、または Eclipse のインストール・フォルダーに対応するディレクトリーなどになります。これは、Eclipse 実行可能プログラムが存在するディレクトリーです。 ロケーションは、絶対パスを使用して指定します。 |
はい |
| report | レポートが生成される出力ロケーションを設定します。 タスクが完了すると、このディレクトリーでレポートが使用可能になります。レポートされる問題のあるコンポーネントごとにサブフォルダーが作成されます。各サブフォルダーには、「report.xml」という名前のファイルが含まれています。 ロケーションは、絶対パスを使用して指定します。 |
はい |
| apiusescans | この属性は、プロファイルに照らし合わせて検査する API 使用スキャンのロケーションのコンマ区切りリストを指定します。
このロケーションは、.zip ファイル、または API 使用スキャン・レポートに対応するディレクトリーなどになります。これは、使用スキャンで XML フォルダーが存在するディレクトリーです。 |
はい |
| excludelist | 除外リストのロケーションを設定します。 この除外リストのロケーションでは、分析から除外するバンドルをリストしたテキスト・ファイルを指定します。 デフォルトでは、プロファイルのすべてのバンドルが分析されます。インクルードおよび除外リスト属性を使用して、バンドルを選択的にインクルードしたり除外したりできます。インクルード・リストで、分析するバンドルのセットが初期化され (これを省略すると、すべてのバンドルがインクルードされる)、その後、除外リストが適用されます。 ファイルの各行は、次のうちの 1 つを指定します。
ロケーションは、絶対パスを使用して指定します。 除外リストの例を以下に示します。 # DOC BUNDLES org.eclipse.jdt.doc.isv org.eclipse.jdt.doc.user org.eclipse.pde.doc.user org.eclipse.platform.doc.isv org.eclipse.platform.doc.user # NON-ECLIPSE BUNDLES com.ibm.icu com.jcraft.jsch R:javax¥..* ... |
いいえ |
| includelist | インクルード・リストのロケーションを設定します。 インクルード・リストのロケーションは、分析に組み込むバンドルをリストするテキスト・ファイルを指定します。 デフォルトでは、プロファイルのすべてのバンドルが分析されます。インクルードおよび除外リスト属性を使用して、バンドルを選択的にインクルードしたり除外したりできます。インクルード・リストで、分析するバンドルのセットが初期化され (これを省略すると、すべてのバンドルがインクルードされる)、その後、除外リストが適用されます。 ファイルの各行は、次のうちの 1 つを指定します。
ロケーションは、絶対パスを使用して指定します。 インクルード・リストの例を以下に示します。 # DOC BUNDLES org.eclipse.jdt.doc.isv org.eclipse.jdt.doc.user org.eclipse.pde.doc.user R:org.eclipse.platform.doc.* # NON-ECLIPSE BUNDLES com.ibm.icu com.jcraft.jsch R:javax¥..* ... |
いいえ |
| preferences | タスクの設定を行います。 この設定を使用して、問題の重大度を構成します。問題の重大度には、無視、警告、またはエラーの 3 つの指定可能な値があります。検出される一連の問題は、API ツールの対応する問題設定キーによって定義されます。 ロケーションは、絶対パスを使用して指定します。指定されたロケーションが存在しない場合、設定は行われません。 「#」で始まる行は無視されます。設定ファイルのフォーマットは、次のようになります。 #Thu Nov 20 17:35:06 EST 2008 API_USE_SCAN_TYPE_SEVERITY=Error API_USE_SCAN_METHOD_SEVERITY=Error API_USE_SCAN_FIELD_SEVERITY=Errorキーは、org.eclipse.pde.api.tools.internal.provisional.problems.IApiProblemTypes で検出できます。 |
いいえ |
| debug | デバッグ値を設定します。
指定可能な値は、 true、false です。デフォルトは false です。
|
いいえ |
<apitooling.apiusescanproblems profile="D:¥eclipse¥3.7¥eclipse" report="D:¥reports¥xml" apiusescans="D:¥APIUseScan¥ProductOne,D:¥APIUseScan¥ProductTwo" excludelist="D:¥exclude_list_external.txt" preferences="D:¥tests_api¥org.eclipse.pde.api.tools.prefs" debug="true" />
これにより、フォルダー D:¥reports¥xml 内に report.xml ファイルを作成するタスクが実行されます。使用スキャンのタイプ、メソッド、およびフィールドは D:¥eclipse¥3.7¥eclipse にあるプロファイルで解決され、欠落しているものはレポートされます。
その際、ファイル D:¥exclude_list_external.txt の除外リストを使用して、問題をレポートするバンドルの数を削減します。
問題の重大度は、D:¥tests_api¥org.eclipse.pde.api.tools.prefs の指定に従って生成されます。
デバッグが使用可能であるため、いくつかのデバッグ・トレースが Ant コンソールに表示されます。

API 分析の Ant タスク
API フリーズの Ant タスク
ファイル生成の Ant タスク
API 使用の Ant タスク
分析レポート変換の Ant タスク
API フリーズ・レポート変換の Ant タスク
API 使用レポート変換の Ant タスク
API 非推奨の Ant タスク
API 非推奨レポート変換の Ant タスク