API 使用扫描问题 Ant 任务

用途

此任务相对于基线来解析概要文件中的 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 设置排除列表位置。

排除列表位置指定将不对其进行分析的文本文件列表捆绑软件。缺省情况下,将对概要文件中的所有捆绑软件进行分析。可以使用包括和排除列表属性来有选择地包括和排除捆绑软件。包括列表确定要分析的捆绑软件集(如果省略了,那么将包括所有捆绑软件),然后应用排除列表。此文件的每一行指定下列其中一项:
  • 特定捆绑软件名称
  • 要与捆绑软件名称进行匹配的正则表达式(带有“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
 R:javax\..*
 ...
否
includelist 设置包括列表位置。

包括列表位置指定要对其进行分析的文本文件列表捆绑软件。缺省情况下,将对概要文件中的所有捆绑软件进行分析。可以使用包括和排除列表属性来有选择地包括和排除捆绑软件。包括列表确定要分析的捆绑软件集(如果省略了,那么将包括所有捆绑软件),然后应用排除列表。此文件的每一行指定下列其中一项:
  • 特定捆绑软件名称
  • 要与捆绑软件名称进行匹配的正则表达式(带有“R:”的行)
  • 注释(带有“#”的行)

使用绝对路径来指定此位置。
以下是包括列表的一个示例:
 # 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 设置任务的首选项。

首选项用来配置问题严重性。问题严重性的值可能是:“忽略”、“警告”或“错误”。 检测到的问题集由 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 任务