比較 Ant タスク

目的

このタスクは、ベースラインに対して相対的な API プロファイルの完全な比較を実行します。

使用法

説明

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

<apitooling.compare
	baseline="..."
	profile="..."
	report="..."
	excludelist="..."
	includelist="..."
	components="..."
	visibility="..."
	debug="..."
/>

パラメーター

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

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

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

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

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

タスクが完了すると、このディレクトリーで「compare.xml」と呼ばれるレポートが使用可能になります。

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

この除外リストのロケーションでは、分析から除外するバンドルをリストしたテキスト・ファイルを指定します。 デフォルトでは、プロファイルのすべてのバンドルが分析されます。インクルードおよび除外リスト属性を使用して、バンドルを選択的にインクルードしたり除外したりできます。インクルード・リストで、分析するバンドルのセットが初期化され (これを省略すると、すべてのバンドルがインクルードされる)、その後、除外リストが適用されます。 ファイルの各行は、次のうちの 1 つを指定します。
  • 特定のバンドル名
  • バンドル名と突き合わせる正規表現 (行は "R:" で始まる)
  • コメント (行は '#' で始まる)

ロケーションは、絶対パスを使用して指定します。
除外リストの例を以下に示します。
 # 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
 # Exclude all pde bundles
 R:org¥.eclipse¥.pde¥..*
 ...
除外リストには、「R:」で始まる行の正規表現を含めることができます。
いいえ
includelist インクルード・リストのロケーションを設定します。

インクルード・リストのロケーションは、分析に組み込むバンドルをリストするテキスト・ファイルを指定します。 デフォルトでは、プロファイルのすべてのバンドルが分析されます。インクルードおよび除外リスト属性を使用して、バンドルを選択的にインクルードしたり除外したりできます。インクルード・リストで、分析するバンドルのセットが初期化され (これを省略すると、すべてのバンドルがインクルードされる)、その後、除外リストが適用されます。 ファイルの各行は、次のうちの 1 つを指定します。
  • 特定のバンドル名
  • バンドル名と突き合わせる正規表現 (行は "R:" で始まる)
  • コメント (行は '#' で始まる)

ロケーションは、絶対パスを使用して指定します。
インクルード・リストの例を以下に示します。
 # 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
 # Exclude all pde bundles
 R:org¥.eclipse¥.pde¥..*
 ...
いいえ
debug デバッグ値を設定します。

指定可能な値は、true、false です。
デフォルトは false です。
いいえ
components コンポーネントのリストのロケーションを設定します。

コンポーネントのリストには、比較する必要があるすべてのコンポーネントの名前を含めます。 このリストを指定しない場合は、所定のベースラインのすべてのコンポーネントが比較されます。
ロケーションは、絶対パスを使用して指定します。
コンポーネントのリスト・ファイルのフォーマットは、次のようになります。
 # 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
 # Include all pde bundles
 R:org¥.eclipse¥.pde¥..*
 ...
コンポーネントのリストには、「R:」で始まる行の正規表現を含めることができます。
いいえ
visibility 可視性の値を設定します。

指定可能な値は、API、ALL です。
デフォルトは API です。
いいえ

例

	<apitooling.compare
		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 内に compare.xml ファイルを作成するタスクが実行されます。除外リストを使用して、レポートする問題の数を削減します。

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

関連参照

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