API フリーズの Ant タスク

目的

このタスクは、API ベースラインに対して相対的に追加、変更、削除された API を識別します。このタスクは、API フリーズの後に API の変更が発生していないことを検証することを目的としています。

使用法

説明

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

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

パラメーター

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

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

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

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

ロケーションは、絶対パスを使用して指定します。
はい
report 生成されるレポート・ファイルの名前を設定します。

これは、絶対パスを使用して指定します。
これはディレクトリーではなく、ファイルのロケーションでなければなりません。
はい
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;
# ECLIPSE BUNDLES
org.eclipse.ui.workbench_3.4.0:org.eclipse.ui.ISharedImages#IMG_DEC_FIELD_ERROR
org.eclipse.ui.workbench_3.4.0:org.eclipse.ui.ISharedImages#IMG_DEC_FIELD_WARNING
org.eclipse.ui.workbench_3.4.0:org.eclipse.ui.ISharedImages#IMG_ELCL_COLLAPSEALL
# NON-ECLIPSE BUNDLES
com.ibm.icu
R:javax¥..*
...
いいえ
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;
# ECLIPSE BUNDLES
org.eclipse.ui.workbench_3.4.0:org.eclipse.ui.ISharedImages#IMG_DEC_FIELD_ERROR
org.eclipse.ui.workbench_3.4.0:org.eclipse.ui.ISharedImages#IMG_DEC_FIELD_WARNING
org.eclipse.ui.workbench_3.4.0:org.eclipse.ui.ISharedImages#IMG_ELCL_COLLAPSEALL
# NON-ECLIPSE BUNDLES
com.ibm.icu
R:javax¥..*
...
いいえ
debug デバッグ値を設定します。

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

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

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

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

例

	<apitooling.apifreeze
		baseline="D:¥eclipse¥3.4.1¥eclipse"
		profile="D:¥eclipse-SDK-I20081118-0800-linux-gtk.tar.gz"
		report="D:¥report¥report.xml"
		excludelist="D:¥exclude_list.txt"
		debug="true"
	/>

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

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

関連参照

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