Tâche Ant de génération de fichier des utilitaires d'API

Objectif

Cette tâche génère tous les fichiers nécessaires aux utilitaires d'API dans un regroupement binaire. La tâche est exécutée lors des générations Eclipse ou de l'exportation de regroupement pour tous les projets ayant une nature d'utilitaire API.

Actuellement, seul le fichier .api_description est créé.

Syntaxe

Description

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

<apitooling.apigeneration
	projectname="..."
	project="..."
	binary="..."
	target="..."
	debug="..."
/>

Paramètres

Attribut Description Obligatoire
projectname Définit le nom du projet Oui
projet Définit l'emplacement du projet.

Il s'agit du dossier qui contient tous les fichiers source du projet.

L'emplacement est défini en utilisant un chemin absolu.
Oui
binaire Définit les emplacements des fichiers binaires.

Il s'agit d'une liste de dossiers ou de fichiers jar qui contiennent tous les fichiers .class du projet. Ils sont séparés par le séparateur de chemin de plateforme. Chaque entrée doit exister.

Les entrées doivent être définies en utilisant des chemins absolus.
Oui
Cible Définit l'emplacement cible.

Il s'agit du dossier de génération des fichiers.

L'emplacement est défini en utilisant un chemin absolu.
Oui
debug Définit la valeur de débogage.

Les valeurs possibles sont true, false
La valeur par défaut est false.
Non
extraManifests Définit les emplacements des fichiers manifeste supplémentaires.

Il s'agit d'une liste d'emplacements de fichiers MANIFEST.MF supplémentaires pouvant être définis pour fournir un plus grand nombre de packages d'API à analyser. Ils sont séparés par le séparateur de chemin de plateforme. Chaque entrée doit exister.

Si le chemin d'accès n'est pas absolu, il est résolu relativement au répertoire de travail en cours.

Vous pouvez spécifier des fichiers jar à la place du fichier MANIFEST.MF. Si un fichier jar est spécifié, son fichier MANIFEST.MF est lu s'il existe.
Non
extraSourceLocations Définit les emplacements des sources supplémentaires.

Il s'agit d'une liste d'emplacements pour les fichiers source à analyser. Ils sont séparés par le séparateur de chemin de plateforme. Chaque entrée doit exister.

Les entrées doivent être définies en utilisant des chemins absolus.
Non
allowNonapiproject Autorise l'exécution de la tâche sur des projets non configurés pour prendre en charge les utilitaires d'API.

Si cette tâche est exécutée sur un projet qui n'est pas de nature utilitaire d'API, aucun fichier api_description n'est généré car il est admis que le projet ne prend pas en charge les utilitaires d'API. Dans certains cas, il est nécessaire de générer le fichier de description sur des projets qui ne sont pas de cette nature. Lorsque ce paramètre est défini sur true, la tâche ne contrôle pas la nature.
Non

Exemples

 <apitooling.apigeneration
  projectname="org.eclipse.jdt.core_3.5.0.v_927"
  project="d:\eclipse\org.eclipse.jdt.core"

  binary="d:\eclipse\org.eclipse.jdt.core\bin;d:\eclipse\org.eclipse.jdt.core\antbin"
  target="d:\plugins\org.eclipse.jdt.core"
  debug="true"
 />

Cet exemple crée le fichier .api_description dans le dossier d:\plugins\org.eclipse.jdt.core en fonction de la source contenue dans d:\eclipse\org.eclipse.jdt.core et les fichiers .class contenus dans d:\eclipse\org.eclipse.jdt.core\bin.

Référence connexe

Tâche Ant d'analyse
Tâche Ant de gel d'API
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