此任务标识已经相对于 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 | 设置排除列表位置。
排除列表位置指定将不对其进行分析的文本文件列表捆绑软件。缺省情况下,将对概要文件中的所有捆绑软件进行分析。可以使用包括和排除列表属性来有选择地包括和排除捆绑软件。此外,此任务支持列示包括列表和排除列表中的成员。包括列表确定要分析的捆绑软件和成员的集合(如果省略了,那么将包括所有捆绑软件和成员),然后应用排除列表。此文件的每一行指定下列其中一项:
使用绝对路径来指定此位置。 以下是排除列表的一个示例: # 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 | 设置包括列表位置。
包括列表位置指定要对其进行分析的文本文件列表捆绑软件。缺省情况下,将对概要文件中的所有捆绑软件进行分析。可以使用包括和排除列表属性来有选择地包括和排除捆绑软件。此外,此任务支持列示包括列表和排除列表中的成员。包括列表确定要分析的捆绑软件和成员的集合(如果省略了,那么将包括所有捆绑软件和成员),然后应用排除列表。此文件的每一行指定下列其中一项:
使用绝对路径来指定此位置。 以下是包括列表的一个示例: # 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 任务