Инструменты API - Задача Ant генерации файла

Назначение

Эта задача запускается для создания всех файлов, необходимых для Инструментов API, в комплекте двоичных данных. Эта задача выполняется при компоновке Eclipse или экспорте комплекта для всех проектов с классификатором Инструменты API.

В этот момент создается только файл .api_description.

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

Description

Именем задачи Ant является apitooling.apigeneration. Для использования файла jar apitooling-ant.jar он должен быть указан в пути к классам Ant.

<apitooling.apigeneration
	projectname="..."
	project="..."
	binary="..."
	target="..."
	encoding="..."
	debug="..."
/>

Параметры

Атрибут Описание Обязательный
projectname Установите имя проекта Да
проект Установите расположение проекта.

Это папка, которая содержит все исходные файлы для данного проекта.

Расположение задается с помощью абсолютного пути.
Да
двоичный Установите расположения двоичных файлов.

Это список папок или JAR-файлов, который содержит все файлы .class для данного проекта. Они разделяются с помощью символов разделителя путей платформы. Каждая запись должна существовать.

Они должны быть заданы с помощью абсолютных путей.
Да
target Установите целевое расположение.

Это папка, в которой генерируются файлы.

Расположение задается с помощью абсолютного пути.
Да
encoding Укажите кодировку файла.

Эта кодировка применяется при чтении исходных файлов в ходе создания. Если кодировка не указана, то применяется системное свойство file.encoding.

Поскольку указанная кодировка не проверяется, недопустимая кодировка может вызвать исключительную ситуацию UnsupportedEncodingException в задаче Ant.
Нет
debug Установите значение отладки.

Возможные значения: true, false
Значение по умолчанию - false.
Нет
extramanifests Установите расположения дополнительных файлов манифеста.

Это список расположений дополнительных файлов манифеста MANIFEST.MF, которые могут быть установлены для предоставления дополнительных пакетов API для сканирования. Они разделяются с помощью символов разделителя путей платформы. Каждая запись должна существовать.

Если указан не полный путь, то путь вычисляется относительно текущего рабочего каталога.

Вместо файла MANIFEST.MF можно указать файл Jar. Если указан файл jar, то будет считан связанный файл MANIFEST.MF (если он существует).
Нет
extrasourcelocations Установите расположения дополнительных исходных файлов.

Это список расположений для исходных файлов, которые будут сканироваться. Они разделяются с помощью символов разделителя путей платформы. Каждая запись должна существовать.

Они должны быть заданы с помощью абсолютных путей.
Нет
allownonapiproject Разрешить выполнение задачи для проектов, поддерживающих инструменты, отличные от API.

Если эта задача запущена для проекта, не имеющего классификатор Инструменты API, файл api_description создан не будет, поскольку предполагается, что проект не поддерживает инструменты API. В некоторых случаях требуется создать файл описания для проектов без классификатора. Если для этого параметра задать значение true, задача не будет проверять наличие классификатора.
Нет

Примеры

 <apitooling.apigeneration
  projectname="org.eclipse.jdt.core_3.5.0.v_927"
  project="d:\eclipse\org.eclipse.jdt.core"
  binary="d:\eclipse\org.eclipse.jdt.core\bin;d:\eclipse\org.eclipse.jdt.core\antbin"
  target="d:\plugins\org.eclipse.jdt.core"
  encoding="UTF-8"
  allownonapiproject="true"
  debug="true"
 />

Будет создан файл с именем .api_description в папке d:\plugins\org.eclipse.jdt.core на основе исходного текста, содержащегося в файлах d:\eclipse\org.eclipse.jdt.core и .class, которые находятся в d:\eclipse\org.eclipse.jdt.core\bin.

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

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