Tarea Ant Generación de archivos de Herramientas de API

Finalidad

Esta tarea se ejecuta para generar todos los archivos necesarios para las Herramientas de API dentro de un paquete binario. Esta tarea se ejecuta durante las construcciones de Eclipse o durante la exportación de paquetes para todos los proyectos que tienen una naturaleza de Herramientas de API.

Ahora, sólo se crea el archivo llamado .api_description.

Utilización

Descripción

El nombre de la tarea Ant es: apitooling.apigeneration. Para utilizarla, el archivo jar apitooling-ant.jar debe estar en la vía de acceso de clases Ant.

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

Parámetros

Atributo Descripción Necesario
projectname Establecer el nombre del proyecto Sí
proyecto Establecer la ubicación del proyecto.

Esta es la carpeta que contiene todos los archivos fuente para el proyecto dado.

La ubicación se establece mediante una vía de acceso absoluta.
Sí
binario Establecer las ubicaciones binarias.

Esta es una lista de carpetas o archivos jar que contienen todos los archivos .class para el proyecto dado. Se separan con el separador de vías de acceso de la plataforma. Debe existir cada entrada.

Deben especificarse mediante vías de acceso absolutas.
Sí
destino Establecer la ubicación destino.

Esta es la carpeta en la que se generan los archivos generados.

La ubicación se establece mediante una vía de acceso absoluta.
Sí
debug Establecer el valor de depuración.

Los valores posibles son: true, false
El valor por omisión es false.
No
extraManifests Establecer las ubicaciones de archivos de manifiesto adicionales.

Esta es una lista de ubicaciones de archivos MANIFEST.MF adicionales que pueden establecerse para proporcionar más paquetes API a explorar. Se separan con el separador de vías de acceso de la plataforma. Debe existir cada entrada.

Si la vía de acceso no es absoluta, se resolverá de forma relativa al directorio de trabajo actual.

Se pueden especificar archivos Jar en lugar de un archivo MANIFEST.MF. Si se especifica un archivo jar, se leerá el archivo MANIFEST.MF correspondiente si existe.
No
extraSourceLocations Establecer las ubicaciones origen adicionales.

Esto es una lista de ubicaciones de archivos de origen que se escanearán. Se separan con el separador de vías de acceso de la plataforma. Debe existir cada entrada.

Deben especificarse mediante vías de acceso absolutas.
No
allowNonapiproject Permitir que la tarea se ejecute en proyectos con las Herramientas de API inhabilitadas.

Si esta tarea se ejecuta en un proyecto sin una naturaleza Herramientas de API, no se generará ningún archivo api_description, dado que se asume que el proyecto no admite las Herramientas de API. En algunos casos, existe la necesidad de crear el archivo de descripción en proyectos sin dicha naturaleza. Al definir este parámetro como true, la tarea no comprobará si existe una naturaleza.
No

Ejemplos

 <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"
  debug="true"
 />

Esto creará un archivo llamado .api_description dentro de la carpeta d:\plugins\org.eclipse.jdt.core basada en el fuente contenido en d:\eclipse\org.eclipse.jdt.core y los archivos .class contenidos en d:\eclipse\org.eclipse.jdt.core\bin.

Consulta relacionada

Tarea Ant Análisis
Tarea Ant Congelación de API
Tarea Ant Utilización de API
Tarea Ant Conversión de informes de Análisis
Tarea Ant Conversión de informes de Congelación de API
Tarea Ant Obsolescencia de API
Tarea Ant Conversión de informes de Obsolescencia de API
Tarea Ant Conversión de informes de Utilización de API