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).
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="..."
includelist="..."
debug="..."
eefile="..."
/>
| 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 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. Además, esta tarea admite la enumeración de miembros en las listas de inclusiones y exclusiones. La lista de inclusiones define el conjunto de paquetes y miembros a analizar (si se omite, se incluyen todos los paquetes) y, posteriormente, se aplica la lista de exclusiones. Cada línea del archivo especifica:
La ubicación se especifica mediante una vía de acceso absoluta. A continuación figura una lista de exclusiones de ejemplo: # ECLIPSE MEMBERS org.eclipse.jface.databinding_1.2.0:org.eclipse.jface.databinding.viewers.ObservableListContentProvider#getElements(Ljava/lang/Object;)[Ljava/lang/Object; # 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 ...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. Además, esta tarea admite la enumeración de miembros en las listas de inclusiones y exclusiones. La lista de inclusiones define el conjunto de paquetes y miembros a analizar (si se omite, se incluyen todos los paquetes) y, posteriormente, se aplica la lista de exclusiones. Cada línea del archivo especifica:
La ubicación se especifica mediante una vía de acceso absoluta. A continuación figura una lista de inclusiones de ejemplo: # ECLIPSE MEMBERS org.eclipse.jface.databinding_1.2.0:org.eclipse.jface.databinding.viewers.ObservableListContentProvider#getElements(Ljava/lang/Object;)[Ljava/lang/Object; # 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 ... |
No |
| debug |
Establecer el valor de depuración. Los valores posibles son: true,
falseEl 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 |
<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.
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