Tâche Ant de migration d'utilisation des API

Objectif

Cette tâche prend une analyse d'utilisation d'API donnée, tente de la résoudre à nouveau dans une édition de produit candidate spécifique et signale toute référence non résolue.

Syntaxe

Description

Le nom de la tâche Ant est apitooling.apimigration. Pour qu'il puisse être utilisé, le fichier jar apitooling-ant.jar doit figurer dans le chemin d'accès aux classes Ant.

 <apitooling.apimigration
	candidate="..."
	usescan="..."
	scopepattern="..."
	referencepattern="..."
	excludelist="..."
	includelist="..."
	report="..."
	debug="..."
 />

Paramètres

Attribut Description Obligatoire
candidate Cet attribut spécifie le produit à utiliser comme candidat à la migration.

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.

Oui
usescan Cet attribut spécifie l'analyse d'utilisation de produit à comparer au candidat à la migration.

L'analyse d'utilisation est spécifiée avec un chemin d'accès absolu par rapport à la racine de l'analyse d'utilisation.
Oui
scopepattern Cet attribut spécifie le masque d'expression régulière utilisé pour générer la portée des éléments pour la recherche des références "de" dans l'emplacement du produit.

Ce masque doit être une expression régulière syntaxiquement correcte conforme aux spécifications définies ici.
Non
referencepattern Cet attribut définit le masque d'expression régulière utilisé pour générer la portée des éléments pour la recherche des références "à" dans l'emplacement du produit.

Ce masque doit être une expression régulière syntaxiquement correcte conforme aux spécifications définies ici.
Non
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. La liste d'inclusion est tirée de l'ensemble de regroupements devant être analysés (en cas d'omission, tous les regroupements sont inclus), et la liste d'exclusion est appliquée. Chaque ligne du fichier indique l'un des éléments suivants :
  • un nom de regroupement spécifique
  • une expression régulière devant correspondre aux noms de regroupements (lignes associées à "R:")
  • un commentaire (lignes associées à '#')

L'emplacement est défini en utilisant un chemin absolu.
L'exemple ci-dessous illustre la liste d'exclusion :
# EXCLUDED BUNDLES
R:org\.eclipse\..*\.doc\..*
...
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. La liste d'inclusion est tirée de l'ensemble de regroupements devant être analysés (en cas d'omission, tous les regroupements sont inclus), et la liste d'exclusion est appliquée. Chaque ligne du fichier indique l'un des éléments suivants :
  • un nom de regroupement spécifique
  • une expression régulière devant correspondre aux noms de regroupements (lignes associées à "R:")
  • un commentaire (lignes associées à '#')

L'emplacement est défini en utilisant un chemin absolu.
L'exemple ci-dessous illustre la liste d'inclusion :
# INCLUDED BUNDLES
R:org\.eclipse\..*
...
Non
report Définit l'emplacement de génération des rapports.

Une fois la tâche exécutée, les rapports sont disponibles dans ce répertoire dans une structure hiérarchique. Un sous-dossier est créé pour chaque composant ayant un autre regroupement qui y fait référence. Chaque sous-dossier contient un fichier "[bundlename].xml". Ce dossier contient également un sous-dossier "[referencing bundle name].xml" pour chaque regroupement qui fait référence au regroupement du dossier conteneur. Le dossier de regroupement de référence contient l'un des trois sous-dossiers (API, PRIVATE ou OTHER) qui contient les référence de type, de méthode et de zones de ce type.

Deux autres fichiers spéciaux, "not_searched.xml" et "no_apidescription.xml", sont écrits dans le répertoire des rapports ; ils contiennent des informations sur les regroupements de la ligne de base, qui n'ont pas fait l'objet de recherche d'informations d'utilisation et qui ne contiennent pas de fichier .api_description.

L'emplacement est défini en utilisant un chemin absolu.

Exemple :
  root
   |
   +-- "not_searched.xml"
   +-- "no_apidescription.xml"
   +-- bundle name with usage
     |
     +--referencing bundle name
      |
      +-- [API or PRIVATE or OTHER]
       |
       +--[type_ or method_ or field_]references.xml
Oui
debug Définit la valeur de débogage.

Les valeurs possibles sont true, false
La valeur par défaut est false.
Non

Exemples

 <apitooling.apimigration
  candidate="/eclipse/sdk3.5"
  usescan="/eclipse/scans/sdk3.4"

  scopepattern=".*"
  referencepattern="org\.eclipse.*"
  excludelist="D:\exclude_list_external.txt"
  report="/eclipse/apimigration/xml"
  debug="true"

 />

Ce code exécute la tâche en créant des fichiers *.xml dans le dossier /eclipse/apimigration/xml. Cette tâche résout à nouveau toutes les références de l'emplacement usescan - défini par l'expression régulière .* - pour le produit candidat dont l'identificateur commence par org.eclipse (défini par l'expression régulière org\.eclipse.*. Il utilise la liste d'exclusion qui se trouve dans le fichier D:\exclude_list_external.txt pour réduire le nombre d'incidents à signaler.

Si le débogage est activé, un traçage de débogage apparaît dans la console Ant.

Référence connexe

Tâche Ant de gel d'API
Tâche Ant de génération de fichier
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
Tâche Ant de conversion de rapport de migration d'utilisation d'API