Préférences Erreurs/Avertissements d'API

Les préférences suivantes peuvent être définies à l'aide de la page des préférences Page des préférences de console Développement de plug-in > Erreurs/Avertissements d'API.

Les incidents d'API surviennent au cours de la génération d'un projet (automatique et complète) ; les utilitaires divisent les types d'incident en trois catégories, à savoir :

  1. Incidents d'utilisation : le code restreint est appelé par des plug-ins non autorisés
  2. Incompatibilités d'API : des modifications entre des versions ne sont pas compatibles
  3. Incidents de versions : des versions de plug-in ou de code (@since tags) ne sont pas correctes
  4. Options d'analyse : options générales

Vous pouvez également configurer la gravité des incidents pour chaque projet à l'aide de la page de propriétés Erreurs/Avertissements d'API associée à un projet.

Utilisation de l'API

Page des préférences des options de syntaxe d'API

Général

Option

Description

Valeur par défaut

Utilisation non prise en charge des balises Javadoc de l'API

Lorsque cette option est activée, le générateur d'analyse d'API vérifie la présence de balises Javadoc d'API utilisées de façon incorrecte.

Ignorer

Référence non définie dans l'environnement d'exécution spécifié

Lorsque cette option est activée, le générateur d'analyse d'API vérifie les références aux bibliothèques système qui pourraient être non conformes à l'environnement d'exécution spécifié pour le regroupement.

Ignorer

Restrictions

Option

Description

Valeur par défaut

Implémentation d'une interface marquée comme '@noimplement'

Lorsque cette option est activée, le générateur d'analyse d'API vérifie la présence d'implémentations non autorisées d'interfaces marquées.

Avertissement

Extension d'un type marqué comme '@noextend'

Lorsque cette option est activée, le générateur d'analyse d'API vérifie la présence de classes qui étendent les types marqués.

Avertissement

Référencement d'une zone ou d'une méthode marquée comme '@noreference'

Lorsque cette option est activée, le générateur d'analyse d'API vérifie la présence de références de zone et de méthode à des membres marqués.

Avertissement

Instanciation d'une classe marquée comme '@noinstantiate'

Lorsque cette option est activée, le générateur d'analyse d'API vérifie que les classes marquées ne sont pas instanciées.

Avertissement

Remplacement d'une méthode marquée comme '@nooverride'

Lorsque cette option est activée, le générateur d'analyse d'API vérifie que les méthodes marquées des classes parent ne sont pas remplacées par une extension (réimplémentées à l'aide d'un appel au parent remplacé) ou par une réimplémentation (sans appel au parent remplacé) dans une classe enfant.

Avertissement

Fuites

Option

Description

Valeur par défaut

Etend une classe non API

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si des classes d'API étendent des types non API.

Avertissement

Implémente une interface non API

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si des classes d'API implémentent une interface non API.

Avertissement

Zone de type non API

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si des types d'API ont des zones publiques ou protégées de type non API.

Avertissement

Méthode comportant un type de retour non API

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si des types d'API ont des méthodes publiques ou protégées comportant des types de retour non API.

Avertissement

Méthode comportant un type de paramètre non API

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si des types d'API ont des méthodes publiques ou protégées comportant des types de paramètre non API.

Avertissement

Compatibilité de l'API

Page des préférences des options de compatibilité de l'API

Option

Description

Valeur par défaut

Signaler les ruptures d'API même si elles sont autorisées par incrément de la version majeure

Lorsque cette option est activée, le générateur d'analyse d'API signale les ruptures d'API si la version majeure du regroupement a déjà été implémentée.

Désactivée

Regroupements

Option

Description

Valeur par défaut

Un type d'API est devenu non API

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si des types d'API dans le regroupement en cours ont été remplacés par des types non-API.

Erreur

Un type a été supprimé

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si des types d'API ont été supprimés de la portée de l'API dans le regroupement donné.

Erreur

Un type réexporté d'API est devenu non-API

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si des types réexportés d'API dans le regroupement en cours ont été remplacés par des types non-API.

Erreur

Un type réexporté a été supprimé

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si des types réexportés d'API ont été supprimés de la portée d'API dans le regroupement considéré.

Erreur

Classe

Option

Description

Valeur par défaut

Une méthode (qui doit être implémentée) a été ajoutée :

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si des méthodes publiques ou protégées devant être implémentées ont été ajoutées à des types API.

Erreur

Des restrictions ont été ajoutées

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si des restrictions d'API ont été modifiées pour des classes d'API.

Erreur

Un paramètre de type a été ajouté

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si des paramètres de type ont été ajoutés à des classes d'API.

Erreur

La hiérarchie des superinterfaces a été réduite

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si des interfaces parent ont été supprimées d'une classe d'API.

Erreur

Le mot clé "abstract" a été ajouté

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si le mot clé "abstract" a été ajouté à des classes d'API.

Erreur

Le mot clé "final" a été ajouté

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si le mot clé "final" a été ajouté à une classe d'API.

Erreur

Converti en annotation, énumération ou interface

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si des classes d'API ont été converties en annotations, énumérations ou interfaces.

Erreur

La visibilité a été réduite

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si des classes d'API publiques ont vu leur portée changée en Privé ou Valeur par défaut.

Erreur

Une zone a été supprimée

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si des zones publiques ou protégées ont été supprimées des classes d'API.

Erreur

Une méthode a été supprimée

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si des méthodes publiques ou protégées ont été supprimées des classes d'API.

Erreur

Un constructeur a été supprimé

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si des constructeurs publics ou protégés ont été supprimés des classes d'API.

Erreur

La hiérarchie des superclasses a été réduite

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si des superclasses ont été supprimés de la hiérarchie.

Erreur

Un type de membre a été supprimé

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si des types de membres ont été supprimés des classes d'API.

Erreur

Un paramètre de type a été supprimé

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si des paramètres de type ont été supprimés d'une classe d'API.

Erreur

Interface

Option

Description

Valeur par défaut

Une zone (interface non marquée comme '@noimplement') a été ajoutée

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si des zones publiques ont été ajoutées à des interfaces d'API.

Erreur

Une méthode (interface non marquée comme '@noimplement') a été ajoutée

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si des méthodes publiques ont été ajoutées à des interfaces d'API.

Erreur

Des restrictions ont été ajoutées

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si des restrictions d'API ont été ajoutées pour des interfaces d'API.

Erreur

Un paramètre de type a été ajouté

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si des paramètres de type ont été ajoutés à des interfaces d'API.

Erreur

Converti en classe, énumération ou annotation

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si des interfaces d'API ont été converties en classes, énumérations ou interfaces.

Erreur

La hiérarchie des superinterfaces a été réduite

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si des interfaces parent ont été supprimées pour des interfaces d'API.

Erreur

Un paramètre de type a été supprimé

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si des paramètres de type ont été supprimés d'une interface d'API.

Erreur

Une zone a été supprimée

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si des zones publiques ont été supprimées des interfaces d'API.

Erreur

Une méthode a été supprimée

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si des méthodes publiques ont été supprimées des interfaces d'API.

Erreur

Un type de membre a été supprimé

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si des types de membre ont été supprimés d'une interface d'API.

Erreur

Enum

Option

Description

Valeur par défaut

La hiérarchie des superinterfaces a été réduite

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si des interfaces parent ont été supprimées d'une énumération d'API.

Erreur

Converti en annotation, classe ou interface

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si des énumérations d'API ont été converties en annotations, classes ou interfaces.

Erreur

Une zone a été supprimée

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si des zones publiques ont été supprimées d'une énumération d'API.

Erreur

Une constante d'énumération a été supprimée

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si des constantes d'énumération ont été supprimées d'une énumération d'API.

Erreur

Une méthode a été supprimée

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si des méthodes publiques ont été supprimées d'une énumération d'API.

Erreur

Un type de membre a été supprimé

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si des types de membres ont été supprimés des énumérations d'API.

Erreur

Annotation

Option

Description

Valeur par défaut

Une méthode sans valeur par défaut a été ajoutée

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si une méthode sans valeur par défaut a été ajoutée à des annotations d'API.

Erreur

Converti en classe, énumération ou interface

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si des annotations d'API ont été converties en classes, énumérations ou interfaces.

Erreur

Une zone a été supprimée

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si des zones publiques ont été supprimées des annotations d'API.

Erreur

Une méthode a été supprimée

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si des méthodes publiques ont été supprimées des annotations d'API.

Erreur

Un type de membre a été supprimé

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si des types de membre publics ont été supprimés des annotations d'API.

Erreur

Zone

Option

Description

Valeur par défaut

Une valeur de constante a été ajoutée

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si une valeur de constante a été ajoutée à des constantes de zones publiques ou protégées non initialisées auparavant pour des types d'API.

Erreur

Le type a été modifié

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si le type des zones publiques ou protégées a été modifié pour des types d'API.

Erreur

La valeur de constante a été modifiée

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si la valeur des constantes de zone publique ou protégée a été modifiée dans des types d'API.

Erreur

La visibilité a été réduite

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si des zones publiques ou protégées sont devenues privées dans des types d'API.

Erreur

Le mot clé "final" a été supprimé pour la constante statique

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si le mot clé final a été supprimé dans des zones publiques ou protégées dans des types d'API.

Erreur

Le mot clé "final" a été ajouté

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si le mot clé final a été ajouté à des zones publiques ou protégées dans des types d'API.

Erreur

Le mot clé "static" a été supprimé

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si le mot clé static a été supprimé des zones publiques ou protégées dans des types d'API.

Erreur

Le mot clé "static" a été ajouté

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si le mot clé static a été ajouté à des zones publiques ou protégées dans des types d'API.

Erreur

La valeur de constante a été supprimée

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si la valeur d'une zone de constante a été supprimée pour des constantes de zones publiques ou protégées dans des types d'API.

Erreur

Un argument de type a été supprimé

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si un argument de type a été supprimé des zones publiques ou protégées dans les types d'API.

Erreur

Méthode

Option

Description

Valeur par défaut

La restriction @nooverride a été ajoutée

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si les restrictions des méthodes publiques ou protégées ont été changées dans les types d'API en ajoutant la balise @nooverride.

Erreur

Un paramètre de type a été ajouté

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si un paramètre de type a été ajouté à des méthodes publiques ou protégées pour des types d'API.

Erreur

Conversion du type d'argument de variable en type de tableau

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si un argument varargs a été développé en un tableau d'objets pour des méthodes publiques ou protégées pour des types d'API.

Erreur

La visibilité a été réduite

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si des méthodes publiques ou protégées sont devenues privées pour des types d'API.

Erreur

Le mot clé "abstract" a été ajouté

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si des méthodes publiques ou protégées sont devenues abstraites dans des types d'API.

Erreur

Le mot clé "static" a été ajouté

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si des méthodes publiques ou protégées sont devenues statiques dans des types d'API.

Erreur

Le mot clé "static" a été supprimé

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si des méthodes publiques ou protégées sont devenues non statiques dans des types d'API.

Erreur

Le mot clé "final" a été ajouté (type marqué comme '@noextend')

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si des méthodes publiques ou protégées sont devenues finales dans des types d'API marqués comme @noextend.

Erreur

La valeur d'annotation par défaut a été supprimée

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si la valeur par défaut associée à une méthode d'annotation d'API a été supprimée.

Erreur

Un paramètre de type a été supprimé

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si un paramètre de type a été supprimé d'une méthode publique ou protégée pour des types d'API.

Erreur

Constructeur

Option

Description

Valeur par défaut

Un paramètre de type a été ajouté

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si un paramètre de type a été ajouté à des constructeurs publics de types d'API.

Erreur

Conversion du type d'argument de variable en type de tableau

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si des paramètres varargs ont été développés en tableaux d'objets pour des constructeurs publics de types d'API.

Erreur

La visibilité a été réduite

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si des constructeurs publics sont devenus non publics dans des types d'API.

Erreur

Un paramètre de type a été supprimé

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si un paramètre de type a été supprimé d'un constructeur public pour des types d'API.

Erreur

Paramètre de type

Option

Description

Valeur par défaut

Une limite de classe a été ajoutée

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si une limite de classe a été ajoutée a un paramètre de type des types d'API.

Erreur

Une limite d'interface a été ajoutée

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si des limites d'interface ont été ajoutées à un paramètre des types d'API.

Erreur

Une limite de classe a été modifiée

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si des limites de classe ont été modifiées dans un paramètre des types d'API.

Erreur

Une limite d'interface a été modifiée

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si des limites d'interface ont été modifiées dans un paramètre des types d'API.

Erreur

Une limite de classe a été supprimée

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si des limites de classe ont été supprimées dans un paramètre des types d'API.

Erreur

Une limite d'interface a été supprimée

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si des limites d'interface ont été supprimées dans un paramètre des types d'API.

Erreur

Gestion des versions

Page des préférences des options de gestion des versions d'API

Option

Description

Valeur par défaut

Signaler les balises '@since' manquantes

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si des balises @since sont manquantes pour des types ou des membres ajoutés depuis la version de la référence d'API utilisée.

Erreur

Signaler les balises '@since' incorrectes

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si la syntaxe des balises @since actuellement utilisées est correcte.

Erreur

Signaler la version de balise '@since' non valide

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si la version des balises @since actuellement utilisées est appropriée.

Erreur

Signaler la version de regroupement incompatible

Lorsque cette option est activée, le générateur d'analyse d'API vérifie si la version de regroupement du plug-in est correcte, d'après les modifications de l'API et la référence d'API actuellement utilisée.

Erreur

Ignorer l'incrément de version mineure sans modifications d'API

Si le signalement des numéros de version incompatibles est activé, cette option peut être utilisée pour demander au générateur d'analyse d'API d'ignorer les incréments de version mineurs si l'API n'a pas été modifiée par rapport à la référence d'API actuelle.

Activée

Ignorer l'incrément de version majeure sans rupture d'API

Si le signalement des numéros de version incompatibles est activé, cette option peut être utilisée pour demander au générateur d'analyse d'API d'ignorer les incréments de version importants si l'API n'a pas été modifiée par rapport à la référence d'API actuelle.

Activée

Options d'analyse

Page des préférences Options d'analyse

Option

Description

Valeur par défaut

Une contrainte/condition requise manque dans le regroupement

Lorsque cette option est activée, le générateur d'analyse d'API signale toute contrainte ou condition nécessaire qui l'empêche le générateur d'effectuer une analyse complète. Quelle que soit la valeur de cette option, l'analyse est ignorée pour le regroupement correspondant.

Erreur

Filtres d'incidents d'API inutilisés

Lorsque cette option est activée, le générateur d'analyse d'API signale les filtres d'incident d'API qui ne sont plus utilisés.

Avertissement

Options d'analyse d'utilisation d'API

Page de préférences des options d'analyse d'utilisation d'API

Option

Description

Valeur par défaut

Problème de type non résolu

Lorsque cette option est activée, le générateur d'analyse d'API signale les types d'API supprimés qui sont inclus dans une analyse d'utilisation répertoriée dans la page de préférences Analyses d'utilisation d'API.

Erreur

Problème de méthode non résolue

Lorsque cette option est activée, le générateur d'analyse d'API signale les méthodes supprimées qui sont incluses dans une analyse d'utilisation répertoriée dans la page de préférences Analyses d'utilisation d'API.

Erreur

Problème de champ non résolu

Lorsque cette option est activée, le générateur d'analyse d'API signale les champs supprimés qui sont inclus dans une analyse d'utilisation répertoriée dans la page de préférences Analyses d'utilisation d'API.

Erreur


Référence connexe

Préférences PDE
Page de propriétés Erreurs/Avertissements d'API
Préférences de référence d'API
Préférences des analyses d'utilisation d'API