Задача Ant фиксации состояния API

Назначение

Эта задача определяет API, которые были добавлены, изменены или удалены относительно контрольной версии API. Эта задача предназначена для проверки того, не изменен ли API после фиксации его состояния.

Формат

Описание

Именем задачи Ant является apitooling.apifreeze. Для использования JAR-файла apitooling-ant.jar он должен находиться в classpath 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 Установите расположение списка исключений.

Расположение списка исключения указывает текстовый файл, в котором перечислены комплекты, подлежащие исключению из анализа. По умолчанию анализируются все комплекты профайла. Атрибуты списка включения и списка исключения можно использовать для выборочного включения и исключения комплектов. Кроме того, эта задача поддерживает отображение элементов в списках включения и исключения. Список включения задает набор комплектов и элементов для анализа (если не указан, включаются все комплекты и элементы), затем применяется список исключения. Каждая строка файла задает один из следующих элементов:
  • имя определенного комплекта
  • имя определенного элемента
  • регулярное выражение для поиска совпадений с именами комплектов или элементов (строки с "R:")
  • комментарий (строки с '#')

Расположение задается с помощью абсолютного пути.
Пример списка исключения:
# 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 Задайте расположение списка включения.

Расположение списка включения указывает текстовый файл, в котором перечислены комплекты, подлежащие включению в анализ. По умолчанию анализируются все комплекты профайла. Атрибуты списка включения и списка исключения можно использовать для выборочного включения и исключения комплектов. Кроме того, эта задача поддерживает отображение элементов в списках включения и исключения. Список включения задает набор комплектов и элементов для анализа (если не указан, включаются все комплекты и элементы), затем применяется список исключения. Каждая строка файла задает один из следующих элементов:
  • имя определенного комплекта
  • имя определенного элемента
  • регулярное выражение для поиска совпадений с именами комплектов или элементов (строки с "R:")
  • комментарий (строки с '#')

Расположение задается с помощью абсолютного пути.
Пример списка включения:
# 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.

Формат файла описан на этой странице вики.

Файл задается с помощью абсолютного пути.
Нет

Примеры

	<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"
	/>

Выполнится задача, создающая файлы report.xml в папке D:\report. Будет использоваться список исключения D:\exclude_list_external.txt, для того чтобы уменьшить количество неполадок в отчете.

После включения отладки некоторая информация трассировки будет показана на консоли Ant.

Связанные ссылки

Задача Ant анализа
Задача Ant генерации файла
Задача Ant использования API
Задача Ant преобразования отчета об анализе
Задача Ant преобразования отчета о фиксации состояния API
Задача Ant об устаревшем API
Задача Ant преобразования отчета об устаревшем API
Задача Ant преобразования отчета об использовании API