Задача Ant об устаревшем API

Назначение

Эта задача выполняет полный анализ профайла API относительно контрольной версии, выявляя только устаревшие или неустаревшие элементы (классы, поля и методы). Профайл - это текущее состояние продукта, находящегося в разработке. Профайл сравнивается с контрольной версией API на наличие устаревших элементов (обычно предыдущий выпуск продукта).

Использование

Description

Именем задачи 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.

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

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

Примеры

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

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

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

Связанные справочники

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