API 使用迁移 Ant 任务

用途

此任务采用给定 API 使用扫描并尝试在给定候选产品发行版中重新对其解析并报告所有未解析引用。

用法

描述

Ant 任务的名称为 apitooling.apimigration。要使用 JAR 文件 apitooling-ant.jar,此文件必须在 Ant 类路径上。

 <apitooling.apimigration
	candidate="..."
	usescan="..."
	scopepattern="..."
	referencepattern="..."
	excludelist="..."
	includelist="..."
	report="..."
	debug="..."
 />

参数

属性 描述 是否必需
candidate 此属性指定要用作迁移候选项的产品。

它可以是一个 .zip、.jar、.tgz 或 .tar.gz 文件,或者是与 Eclipse 安装文件夹相对应的目录。您可以在此目录中找到 Eclipse 可执行文件。

是
usescan 此属性指定要与迁移候选项进行比较的产品使用扫描。

usescan 是使用该使用扫描的根的绝对路径指定的。
是
scopepattern 此属性指定正则表达式模式,此模式用于构建元素范围以便在产品位置中搜索自这些元素的引用。

该模式必须是按此处定义的格式正确的正则表达式。
否
referencepattern 设置正则表达式模式,此模式用于构建元素范围以便在产品位置中搜索至这些元素的引用。

该模式必须是按此处定义的格式正确的正则表达式。
否
excludelist 设置排除列表位置。

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

使用绝对路径来指定此位置。
以下是排除列表的一个示例:
# EXCLUDED BUNDLES
R:org\.eclipse\..*\.doc\..*
...
否
includelist 设置包括列表位置。

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

使用绝对路径来指定此位置。
以下是包括列表的一个示例:
# INCLUDED BUNDLES
R:org\.eclipse\..*
...
否
report 设置将生成报告的输出位置。

完成了此任务之后,就可以在此目录中使用分层结构来提供报告。 对于每个组件,如果有另一个捆绑软件引用它,就会为它创建子文件夹。 每个子文件夹中都包含一个名为“[bundlename].xml”的文件。 对于引用包含文件夹的捆绑软件的每个捆绑软件,在此文件夹中都有另一个子文件夹(名为“[referencing bundle name].xml”)。此引用捆绑软件文件夹内存在三个子文件夹之一(API、PRIVATE 或 OTHER),它们包含类型、方法或者该类型的字段引用。

已将另外两个特殊文件(即,“not_searched.xml”和“no_apidescription.xml”)写入报告目录,这两个文件中分别包含有关“基线中未对其进行搜索以获取使用情况信息的捆绑软件”以及“不包含 .api_description 文件的捆绑软件”的信息。

使用绝对路径来指定此位置。

例如:
  root
   |
   +-- "not_searched.xml"
   +-- "no_apidescription.xml"
   +-- bundle name with usage
     |
     +--referencing bundle name
      |
      +-- [API or PRIVATE or OTHER]
       |
       +--[type_ or method_ or field_]references.xml
是
debug 设置调试值。

此属性的值可为:true 或 false
缺省值为 false。
否

示例

 <apitooling.apimigration
  candidate="/eclipse/sdk3.5"
  usescan="/eclipse/scans/sdk3.4"

  scopepattern=".*"
  referencepattern="org\.eclipse.*"
  excludelist="D:\exclude_list_external.txt"
  report="/eclipse/apimigration/xml"
  debug="true"

 />

这将运行在文件夹 /eclipse/apimigration/xml 中创建 *.xml 文件的任务。 该任务将在 usescan 位置(此位置由 .* 正则表达式定义)针对标识以 org.eclipse 开头的候选产品(由 org\.eclipse.* 正则表达式定义)重新解析所有引用。 它将使用位于 D:\exclude_list_external.txt 中的排除列表文件来减少要报告的问题数。

如果启用了调试,那么某些调试跟踪将显示在 Ant 控制台中。

相关参考

API 冻结 Ant 任务
文件生成 Ant 任务
分析报告转换 Ant 任务
API 冻结报告转换 Ant 任务
API 不推荐 Ant 任务
API 不推荐报告转换 Ant 任务
API 使用报告转换 Ant 任务
API 使用迁移报告转换 Ant 任务