Tarea Ant Obsolescencia de API

Finalidad

Esta tarea ejecuta un an�lisis de API completo de un perfil de API relativo a una l�nea base, buscando s�lo miembros (clases, campos m�todos) que est�n en desuso / o hayan vuelto a usarse. El perfil es el estado actual de un producto bajo desarrollo. El perfil se compara con una l�nea base de API para cambios de obsolescencia (normalmente, el release anterior de un producto).

Utilizaci�n

Descripci�n

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

<apitooling.apideprecation
	baseline="..."
	profile="..."
	report="..."
	excludelist="..."
	debug="..."
	eefile="..."
/>

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�n los informes.

Una vez completada la tarea, hay informes disponibles en este directorio mediante una estructura similar a la ra�z del filtro. Se crea una subcarpeta para cada componente con problemas de los que informar. Cada subcarpeta contiene un archivo llamado "report.xml".

Tambi�n se crea una carpeta especial llamada "allNonApiBundles" en esta carpeta que tambi�n contiene un archivo llamado "report.xml". Este archivo crea una lista de todos los paquetes que no utilizan la naturaleza Herramientas de API.

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

La lista de exclusiones se utiliza para saber qu� paquetes deben excluirse del informe xml generado por la ejecuci�n de la tarea. Las l�neas que empiezan por '#' no se incluyen en los elementos excluidos.
La ubicaci�n se especifica mediante una v�a de acceso absoluta.
El formato del archivo de lista de exclusiones tiene el aspecto siguiente:
 # PAQUETES DOC
 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
 # PAQUETES NO-ECLIPSE
 com.ibm.icu
 com.jcraft.jsch
 javax.servlet
 javax.servlet.jsp
 ...
No
debug Establecer el valor de depuraci�n.

Los valores posibles son: true, false
El valor por omisi�n es false.
No
eefile Establezca el archivo de entorno de ejecuci�n a utilizar.

De forma predeterminada, se utiliza un archivo de entorno de ejecuci�n que corresponde a un entorno de ejecuci�n JavaSE-1.6.

El formato del archivo se describe en esta p�gina wiki.

El archivo se especifica mediante una v�a de acceso absoluta.
No

Ejemplos

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

Esto ejecutar� la tarea creando archivos report.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.

Consulta 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