Assistant des modèles d'utilisation d'API

Cet assistant vous aide à créer des modèles d'expression régulière pour contrôler une analyse d'utilisation d'API.

Pour activer l'assistant, procédez comme suit :

  1. Lorsque vous créez une configuration de lancement de rapport d'utilisation d'API, passez dans l'onglet Modèles.
  2. Dans l'onglet, cliquez sur le bouton Ajouter....

Option

Description

Valeur par défaut

Types de modèle Cette liste répertorie tous les modèles pouvant être créés avec l'assistant. Premier élément de la liste
Description Affiche une description lisible du type de modèle sélectionné dans la liste Types de modèle.  

La première page de l'assistant permet de sélectionner le type de modèle à créer. Des descriptions pour chaque modèle vous aident à effectuer votre choix ; sélectionnez simplement le modèle pour afficher sa description dans la zone Description.

Assistant Modèle d'utilisation d'API - page de sélection de modèle

Modèles d'archive

Lors de l'analyse d'utilisation des API, tous les dossiers et archives d'un regroupement sont analysés ce qui garantit l'analyse de tous les fichiers classe. Dans certains cas, un regroupement peut comporter une archive contenant des anciennes versions des fichiers classe (par exemple) que vous ne voulez pas analyser. Il est alors judicieux d'utiliser un modèle d'archive pour ignorer complètement une archive spécifique ou toutes les archives correspondant à une expression régulière donnée.

Option

Description

Valeur par défaut

Nom du regroupement Nom symbolique complet du regroupement auquel appliquer le modèle. Exemple : org.eclipse.pde.api.tools. Vide
Nom de l'archive Nom complet ou expression régulière de l'archive ou des archives auxquelles appliquer le modèle. Exemple : *.jar - ignore tous les fichiers jar imbriqués. Vide

Assistant Modèle d'utilisation d'API - création de modèles d'archive

Modèles de package

Lors de l'extraction des références en vue de l'analyse, le moteur de recherche d'utilisation d'API utilise des métadonnées provenant du regroupement pour déterminer si une référence est interne ou non. Dans certains cas, il se peut qu'un regroupement n'ait pas été configuré pour décrire correctement quelles sont les classes qui sont internes et quelles sont les classes qui ne le sont pas. Un modèle de package vous permet d'augmenter ces regroupements syntaxiquement incorrects (du point de vue du moteur de recherche uniquement, le regroupement réel n'étant pas modifié) pour décrire les classes internes et celles qui ne le sont pas.

Option

Description

Valeur par défaut

Modèle Modèle d'expression régulière à laquelle les packages doivent correspondre. Exemple : .*\.internal\..*. Vide
Modèle d'API Indique que le modèle doit faire en sorte que les packages correspondants soient considérés comme des API ou non. Sélectionné

Assistant Modèle d'utilisation d'API - création de modèles de package

Modèles de conversion de rapport

Lorsqu'une analyse d'utilisation d'API est terminée, la quantité d'informations à examiner peut être très conséquente. Toutefois, avec un modèle de conversion de rapport, vous pouvez réduire la quantité d'informations de référence présentées dans les rapports HTML pour ne voir que celles qui vous intéressent. Pour ce faire, vous pouvez créer des modèles d'exclusion afin d'élaguer les références figurant dans les rapports.

Option

Description

Valeur par défaut

Filtrer les références vers ce modèle Permet d'ignorer les références figurant dans les rapports en fonction du modèle. Par exemple, si le modèle est org\.eclipse\.jdt\..* et que vous sélectionnez cette option, le rapport ne contiendra pas de référence à JDT. sélectionnée
Filtrer les références à partir de ce modèle Permet d'ignorer les références figurant dans les rapports en fonction du modèle. Par exemple, si le modèle est org\.eclipse\.jdt\..* et que vous sélectionnez cette option, le rapport ne contiendra pas de références provenant de JDT.  
Modèle Modèle d'expression régulière. Vide

Assistant Modèle d'utilisation d'API - création de modèles de conversion de rapport

Tâches connexes

Configuration des utilitaires d'API

Référence connexe

Action de configuration des outils d'API
Menu contextuel Outils PDE
Rapports d'utilisation d'API