API 非推奨の Ant タスク

目的

このタスクは、ベースラインに対して相対的な API プロファイルの完全な API 分析を実行します。その際、非推奨/推奨になったメンバー (クラス、フィールド、メソッド) だけを探します。 プロファイルは、開発中の製品の現行状態です。非推奨変更について、プロファイルは API ベースラインと比較されます (通常、製品の前のリリース)。

使用法

説明

Ant タスクの名前は、apitooling.apideprecation です。 使用するには、jar ファイル apitooling-ant.jar が Ant クラスパス上になければなりません。

<apitooling.apideprecation
	baseline="..."
	profile="..."
	report="..."
	excludelist="..."
	includelist="..."
	debug="..."
	eefile="..."
/>

パラメーター

属性 説明 必須
baseline この属性は、参照ベースラインのロケーションを指定します。

このロケーションは、.zip、.jar、.tgz、.tar.gz ファイル、または Eclipse のインストール・フォルダーに対応するディレクトリーなどになります。これは、Eclipse 実行可能プログラムが存在するディレクトリーです。

ロケーションは、絶対パスを使用して指定します。
はい
profile この属性は、参照ベースラインに対して比較する、現行製品またはプロファイルのロケーションを指定します。

このロケーションは、.zip、.jar、.tgz、.tar.gz ファイル、または Eclipse のインストール・フォルダーに対応するディレクトリーなどになります。これは、Eclipse 実行可能プログラムが存在するディレクトリーです。

ロケーションは、絶対パスを使用して指定します。
はい
report レポートが生成される出力ロケーションを設定します。

タスクが完了すると、このディレクトリーでフィルター・ルートと類似する構造を使用することで、レポートが使用可能になります。レポートされる問題のあるコンポーネントごとにサブフォルダーが作成されます。各サブフォルダーには、「report.xml」という名前のファイルが含まれています。

このフォルダーには、「allNonApiBundles」という名前の特別なフォルダーも作成され、そのフォルダーにも「report.xml」という名前のファイルが含まれます。このファイルには、API ツール・ネーチャーを使用していないすべてのバンドルがリストされます。

ロケーションは、絶対パスを使用して指定します。
はい
excludelist 除外リストのロケーションを設定します。

この除外リストのロケーションでは、分析から除外するバンドルをリストしたテキスト・ファイルを指定します。 デフォルトでは、プロファイルのすべてのバンドルが分析されます。インクルードおよび除外リスト属性を使用して、バンドルを選択的にインクルードしたり除外したりできます。さらに、このタスクは、インクルードおよび除外リストによるメンバーのリストをサポートします。インクルード・リストは分析されるバンドルとメンバーの集合をシードし (リストを指定しない場合は、すべてのバンドルとメンバーがインクルードされます)、それから除外リストが適用されます。 ファイルの各行は、次のうちの 1 つを指定します。
  • 特定のバンドル名
  • 特定のメンバー名
  • バンドルまたはメンバー名にマッチングする正規表現 (「R:」で始まる行)
  • コメント (行は '#' で始まる)

ロケーションは、絶対パスを使用して指定します。
除外リストの例を以下に示します。
 # ECLIPSE MEMBERS
 org.eclipse.jface.databinding_1.2.0:org.eclipse.jface.databinding.viewers.ObservableListContentProvider#getElements(Ljava/lang/Object;)[Ljava/lang/Object;
 # 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
 javax.servlet
 javax.servlet.jsp
 ...
除外リストには、「R:」で始まる行の正規表現を含めることができます。
いいえ
includelist インクルード・リストのロケーションを設定します。

インクルード・リストのロケーションは、分析に組み込むバンドルをリストするテキスト・ファイルを指定します。 デフォルトでは、プロファイルのすべてのバンドルが分析されます。インクルードおよび除外リスト属性を使用して、バンドルを選択的にインクルードしたり除外したりできます。さらに、このタスクは、インクルードおよび除外リストによるメンバーのリストをサポートします。インクルード・リストは分析されるバンドルとメンバーの集合をシードし (リストを指定しない場合は、すべてのバンドルとメンバーがインクルードされます)、それから除外リストが適用されます。 ファイルの各行は、次のうちの 1 つを指定します。
  • 特定のバンドル名
  • 特定のメンバー名
  • バンドルまたはメンバー名にマッチングする正規表現 (「R:」で始まる行)
  • コメント (行は '#' で始まる)

ロケーションは、絶対パスを使用して指定します。
インクルード・リストの例を以下に示します。
 # ECLIPSE MEMBERS
 org.eclipse.jface.databinding_1.2.0:org.eclipse.jface.databinding.viewers.ObservableListContentProvider#getElements(Ljava/lang/Object;)[Ljava/lang/Object;
 # 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
 javax.servlet
 javax.servlet.jsp
 ...
いいえ
デバッグ デバッグ値を設定します。

指定可能な値は、true、false です。
デフォルトは false です。
いいえ
eefile 使用する実行環境ファイルを設定します。

デフォルトでは、JavaSE-1.6 実行環境に対応する実行環境ファイルが使用されます。

ファイルのフォーマットは、この wiki ページで説明されています。

ファイルは、絶対パスを使用して指定します。
いいえ

サンプル

 <apitooling.apideprecation
  baseline="D:¥eclipse¥3.4.1¥eclipse"
  profile="D:¥eclipse-SDK-I20081118-0800-linux-gtk.tar.gz"

  report="D:¥reports¥xml"
  excludelist="D:¥exclude_list_external.txt"
  debug="true"
 />

これにより、フォルダー D:¥reports¥xml 内に report.xml ファイルを作成するタスクが実行されます。除外リストを使用して、レポートする問題の数を削減します。

デバッグが使用可能であるため、いくつかのデバッグ・トレースが Ant コンソールに表示されます。

関連参照

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