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 设置排除列表位置。

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

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

此属性的值可为: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 任务