Cette tâche identifie les API ajoutées, modifiées ou supprimées d'une ligne de base API. Elle vise à vérifier qu'aucune modification d'API n'intervient après le gel d'une API.
Le nom de la tâche Ant est apitooling.apifreeze. Pour qu'il puisse être utilisé, le fichier jar apitooling-ant.jar doit figurer dans le chemin d'accès aux classes Ant.
<apitooling.apifreeze baseline="..." profile="..." report="..." excludelist="..." includelist="..." debug="..." eefile="..." />
| Attribut | Description | Obligatoire |
| baseline | Cet attribut définit l'emplacement de la ligne de base de référence.
Il peut s'agir d'un fichier .zip, .jar, .tgz, .tar.gz ou d'un répertoire qui correspond au dossier d'installation Eclipse. Il s'agit du répertoire dans lequel se trouve l'exécutable Eclipse. L'emplacement est défini en utilisant un chemin absolu. |
Oui |
| profile | Cet attribut définit l'emplacement du produit ou du profil en cours à comparer à la ligne de base de référence.
Il peut s'agir d'un fichier .zip, .jar, .tgz, .tar.gz ou d'un répertoire qui correspond au dossier d'installation Eclipse. Il s'agit du répertoire dans lequel se trouve l'exécutable Eclipse. L'emplacement est défini en utilisant un chemin absolu. |
Oui |
| report | Spécifie le nom du fichier de rapport à générer.
Il est doit être spécifié en utilisant un chemin absolu. Il peut s'agir d'un emplacement de fichier et non d'un répertoire. |
Oui |
| excludelist | Définit l'emplacement de la liste d'exclusion.
L'emplacement de la liste d'exclusion indique les regroupements de fichier texte devant être exclus de l'analyse. Par défaut, tous les regroupements dans le profil sont analysés. Les attributs de liste d'inclusion et d'exclusion peuvent être utilisés pour inclure et exclure des regroupements de manière sélective. De plus, cette tâche prend en charge l'affichage de la liste des membres dans les listes d'inclusion et d'exclusion. La liste d'inclusion est tirée de l'ensemble de regroupements et de membres devant être analysés (en cas d'omission, tous les regroupements et membres sont inclus), et la liste d'exclusion est appliquée. Chaque ligne du fichier indique l'un des éléments suivants :
L'emplacement est défini en utilisant un chemin absolu. L'exemple ci-dessous illustre la liste d'exclusion : # ECLIPSE MEMBERS org.eclipse.jface.databinding_1.2.0:org.eclipse.jface.databinding.viewers.ObservableListContentProvider#getElements(Ljava/lang/Object;)[Ljava/lang/Object; # ECLIPSE BUNDLES org.eclipse.ui.workbench_3.4.0:org.eclipse.ui.ISharedImages#IMG_DEC_FIELD_ERROR org.eclipse.ui.workbench_3.4.0:org.eclipse.ui.ISharedImages#IMG_DEC_FIELD_WARNING org.eclipse.ui.workbench_3.4.0:org.eclipse.ui.ISharedImages#IMG_ELCL_COLLAPSEALL # NON-ECLIPSE BUNDLES com.ibm.icu R:javax\..* ... |
Non |
| includelist | Définit l'emplacement de la liste d'inclusion.
L'emplacement de la liste d'inclusion indique un fichier texte répertoriant les regroupements à inclure dans l'analyse. Par défaut, tous les regroupements dans le profil sont analysés. Les attributs de liste d'inclusion et d'exclusion peuvent être utilisés pour inclure et exclure des regroupements de manière sélective. De plus, cette tâche prend en charge l'affichage de la liste des membres dans les listes d'inclusion et d'exclusion. La liste d'inclusion est tirée de l'ensemble de regroupements et de membres devant être analysés (en cas d'omission, tous les regroupements et membres sont inclus), et la liste d'exclusion est appliquée. Chaque ligne du fichier indique l'un des éléments suivants :
L'emplacement est défini en utilisant un chemin absolu. L'exemple ci-dessous illustre la liste d'inclusion : # ECLIPSE MEMBERS org.eclipse.jface.databinding_1.2.0:org.eclipse.jface.databinding.viewers.ObservableListContentProvider#getElements(Ljava/lang/Object;)[Ljava/lang/Object; # ECLIPSE BUNDLES org.eclipse.ui.workbench_3.4.0:org.eclipse.ui.ISharedImages#IMG_DEC_FIELD_ERROR org.eclipse.ui.workbench_3.4.0:org.eclipse.ui.ISharedImages#IMG_DEC_FIELD_WARNING org.eclipse.ui.workbench_3.4.0:org.eclipse.ui.ISharedImages#IMG_ELCL_COLLAPSEALL # NON-ECLIPSE BUNDLES com.ibm.icu R:javax\..* ... |
Non |
| debug | Définit la valeur de débogage.
Les valeurs possibles sont true, false
La valeur par défaut est false.
|
Non |
| eefile | Définit le fichier d'environnement d'exécution à utiliser.
Par défaut, un fichier d'environnement d'exécution correspondant à un environnement d'exécution JavaSE-1.6 est utilisé. Le format du fichier est décrit dans cette page wiki. Le fichier est défini en utilisant un chemin absolu. |
Non |
<apitooling.apifreeze baseline="D:\eclipse\3.4.1\eclipse" profile="D:\eclipse-SDK-I20081118-0800-linux-gtk.tar.gz" report="D:\report\report.xml" excludelist="D:\exclude_list.txt" debug="true" />
Cet exemple permet d'exécuter la tâche en créant un fichier report.xml dans le dossier D:\report.
Il utilise la liste d'exclusion D:\exclude_list_external.txt pour réduire le nombre d'incidents à signaler.
Etant donné que le débogage est activé, un traçage de débogage apparaît dans la console Ant.

Tâche Ant d'analyse
Tâche Ant de génération de fichier
Tâche Ant d'utilisation d'API
Tâche Ant de conversion de rapport d'analyse
Tâche Ant de conversion de rapport de gel d'API
Tâche Ant de dépréciation d'API
Tâche Ant de conversion de rapport de dépréciation d'API
Tâche Ant de conversion de rapport d'utilisation d'API