Tarea Ant Comparación

Finalidad

Esta tarea ejecuta una comparación completa de un perfil de API relativo a una línea base.

Utilización

Descripción

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

<apitooling.compare
	baseline="..."
	profile="..."
	report="..."
	excludelist="..."
	includelist="..."
	components="..."
	visibility="..."
	debug="..."
/>

Parámetros

Atributo Descripción Necesario
baseline Este atributo especifica la ubicación de la línea base de referencia.

Puede ser un archivo .zip, .jar, .tgz, .tar.gz o un directorio correspondiente a la carpeta de instalación de Eclipse. Se trata del directorio en el que puede encontrar el ejecutable de Eclipse.

La ubicación se especifica mediante una vía de acceso absoluta.
Sí
profile Este atributo especifica la ubicación del producto o perfil actual que desea comparar con la línea base de referencia.

Puede ser un archivo .zip, .jar, .tgz, .tar.gz o un directorio correspondiente a la carpeta de instalación de Eclipse. Se trata del directorio en el que puede encontrar el ejecutable de Eclipse.

La ubicación se especifica mediante una vía de acceso absoluta.
Sí
report Establecer la ubicación de salida en la que se generará el informe.

Una vez completada la tarea, el informe llamado "compare.xml" está disponible en este directorio.

La ubicación se especifica mediante una vía de acceso absoluta.
Sí
excludelist Establecer la ubicación de la lista de exclusiones.

La ubicación de lista de exclusiones especifica un archivo de texto que enumera los paquetes que se excluirán del análisis. De forma predeterminada, se analizan todos los paquetes del perfil. Se pueden utilizar los atributos de lista de inclusiones y exclusiones para incluir y excluir paquetes de forma selectiva. La lista de inclusiones define el conjunto de paquetes a analizar (si se omite, se incluyen todos los paquetes) y, posteriormente, se aplica la lista de exclusiones. Cada línea del archivo especifica:
  • un nombre de paquete específico
  • una expresión regular con la que deben coincidir los nombres de paquete (líneas que empiecen con "R:")
  • un comentario (las líneas con '#')

La ubicación se especifica mediante una vía de acceso absoluta.
A continuación figura una lista de exclusiones de ejemplo:
 # 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
 # Exclude all pde bundles
 R:org\.eclipse\.pde\..*
 ...
La lista de exclusiones puede contener expresiones regulares si la línea empieza por "R:".
No
includelist Establecer la ubicación de la lista de inclusiones.

La ubicación de lista de inclusiones especifica un archivo de texto que enumera los paquetes que se incluirán en el análisis. De forma predeterminada, se analizan todos los paquetes del perfil. Se pueden utilizar los atributos de lista de inclusiones y exclusiones para incluir y excluir paquetes de forma selectiva. La lista de inclusiones define el conjunto de paquetes a analizar (si se omite, se incluyen todos los paquetes) y, posteriormente, se aplica la lista de exclusiones. Cada línea del archivo especifica:
  • un nombre de paquete específico
  • una expresión regular con la que deben coincidir los nombres de paquete (líneas que empiecen con "R:")
  • un comentario (las líneas con '#')

La ubicación se especifica mediante una vía de acceso absoluta.
A continuación figura una lista de inclusiones de ejemplo:
 # 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
 # Exclude all pde bundles
 R:org\.eclipse\.pde\..*
 ...
No
debug Establecer el valor de depuración.

Los valores posibles son: true, false
El valor por omisión es false.
No
components Establecer la ubicación de la lista de componentes.

La lista de componentes incluye todos los nombres de componentes que deben compararse. Si se omite, se compararán todos los componentes de la línea base dada.
La ubicación se especifica mediante una vía de acceso absoluta.
El formato del archivo de lista de componentes tiene el aspecto siguiente.
 # 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
 # Include all pde bundles
 R:org\.eclipse\.pde\..*
 ...
La lista de componentes puede contener expresiones regulares si la línea empieza por "R:".
No
visibility Establecer un valor de visibilidad

Los valores posibles son: API, ALL
El valor predeterminado es API.
No

Ejemplos

	<apitooling.compare
		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"
	/>

Esto ejecutará la tarea creando archivos compare.xml dentro de la carpeta D:\reports\xml. Excluirá la lista para reducir el número de problemas a exportar.

Puesto que la depuración está habilitada, se mostrará algún rastreo de depuración en la consola Ant.

Referencia relacionada

Tarea Ant Congelación de API
Tarea Ant Generación de archivos
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 Conversión de informes de Utilización de API
Tarea Ant Conversión de informes de Obsolescencia de API