Эта задача обрабатывает сканирование использование 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 |
Задает сканирование использования продукта для сравнения с кандидатом для миграции. Укажите полный путь к каталогу, в котором расположено сканирование использования. |
Да |
| scopepattern |
Этот атрибут указывает шаблон регулярного выражения, применяемый для компоновки
области элементов для поиска ссылок в расположении продукта. Шаблон должен быть указан в формате регулярных выражений, описание которого приведено здесь. |
Нет |
| referencepattern |
Укажите шаблон регулярного выражения для компоновки
области элементов для поиска ссылок в расположении продукта. Шаблон должен быть указан в формате регулярных выражений, описание которого приведено здесь. |
Нет |
| excludelist |
Установите расположение списка исключений. Расположение списка исключения указывает текстовый файл, в котором перечислены комплекты, подлежащие исключению из анализа. По умолчанию анализируются все комплекты профайла. Атрибуты списка включения и списка исключения можно использовать для выборочного включения и исключения комплектов. Список включения задает набор комплектов для анализа (если не указан, включаются все комплекты), затем применяется список исключения. Каждая строка файла задает один из следующих элементов:
Расположение задается с помощью абсолютного пути. Пример списка исключения: # EXCLUDED BUNDLES R:org\.eclipse\..*\.doc\..* ... |
Нет |
| includelist |
Задайте расположение списка включения. Расположение списка включения указывает текстовый файл, в котором перечислены комплекты, подлежащие включению в анализ. По умолчанию анализируются все комплекты профайла. Атрибуты списка включения и списка исключения можно использовать для выборочного включения и исключения комплектов. Список включения задает набор комплектов для анализа (если не указан, включаются все комплекты), затем применяется список исключения. Каждая строка файла задает один из следующих элементов:
Расположение задается с помощью абсолютного пути. Пример списка включения: # INCLUDED BUNDLES R:org\.eclipse\..* ... |
Нет |
| report |
Установите расположение вывода, в котором будут
генерироваться отчеты. После выполнения задачи отчеты становятся доступными в этом каталоге с помощью иерархической структуры. Подпапка создается для каждого компонента, на который ссылается другой комплект. Каждая подпапка содержит файл с именем "[имя_комплекта].xml". В этой папке содержится другая подпапка (по имени "[имя ссылающегося комплекта].xml") для каждого комплекта, который ссылается на комплект содержащей папки. В папке ссылающегося комплекта находится одна из трех подпапок (API, PRIVATE или OTHER), которая содержит ссылки на тип, метод или поле этого рода. Два других специальных файла, "not_searched.xml" и "no_apidescription.xml", записаны в каталоге отчета, и они соответственно содержат информацию о тех комплектах из контрольной версии, для которых не производился поиск информации об использовании, и тех комплектах, которые не имеют файлов .api_description. Расположение задается с помощью абсолютного пути. Например:
root
|
+-- "not_searched.xml"
+-- "no_apidescription.xml"
+-- имя комплекта и использование
|
+--имя ссылающегося комплекта
|
+-- [API или PRIVATE или OTHER]
|
+--[type_ или method_ или 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"
/>
Выполнится задача, создающая файлы *.xml в папке
/eclipse/apimigration/xml. Задача заново
обрабатывает все ссылки из расположения
usescan (регулярное выражение .*)
для продукта-кандидата, идентификатор которого
начинается с org.eclipse (регулярное выражение
org\.eclipse.*). Будет использоваться
файл списка исключения, расположенный в каталоге
D:\exclude_list_external.txt, для уменьшения
числа неполадок в отчете.
После включения отладки некоторая информация трассировки будет показана на консоли Ant.
Задача Ant фиксации состояния API
Задача Ant генерации файла
Задача Ant преобразования отчета об анализе
Задача Ant преобразования отчета о фиксации состояния API
Задача Ant об устаревшем API
Задача Ant преобразования отчета об устаревшем API
Задача Ant преобразования отчета об
использовании API
Инструменты API - Задача Ant
преобразования отчета о миграции