Détection d'une méthode (detectMethod)

Elément <detectMethod>

La règle detectMethod permet de détecter des méthodes dans des fichiers de classe Java.

Tableau 1. Attributs de l'élément d' <detectMethod>
Nom d'attribut Tapez Requis Descriptif
nom Chaîne Oui

Nom de la méthode. Si vous en indiquez plusieurs, utilisez une liste d'entrées séparées par des virgules.

Propriétaire Chaîne Oui

Nom complet de la classe où la méthode est définie. Si vous en indiquez plusieurs, utilisez une liste d'entrées séparées par des virgules.

returnType Chaîne Non

Nom de classe complet du type de retour.

arguments Chaîne Non

Noms de classe complets ou primitives des arguments de méthode. Si vous en indiquez plusieurs, utilisez une liste d'entrées séparées par des virgules. Indiquez une chaîne vide pour marquer la méthode sans paramètres. Si cet attribut n'est pas spécifié, marque toutes les signatures de méthode.

excludePackageNames Chaîne Non

Noms de package complets. Si vous en indiquez plusieurs, utilisez une liste d'entrées séparées par des virgules. Vous pouvez l'utiliser pour exclure le marquage de méthodes dans des classes de certains packages. Ajoutez .* au package pour établir une correspondance avec tous les sous-packages. Ajoutez simplement * au nom du package pour établir une correspondance avec ce package, ainsi qu'avec tous les sous-packages.

flagCatchExceptions Chaîne Non

Noms de classe complets des exceptions. Si vous en indiquez plusieurs, utilisez une liste d'entrées séparées par des virgules. Marque les appels à la méthode s'il se trouve à l'intérieur d'un bloc "try and catch" pour l'une des exceptions spécifiées.

flagUnhandledExceptions Chaîne Non

Noms de classe complets des exceptions. Si vous en indiquez plusieurs, utilisez une liste d'entrées séparées par des virgules. Marque les appels à la méthode si aucune des exceptions spécifiées n'est interceptée ou émise par la méthode qui effectue l'appel.

flagOnce Booléen Non

Indique s'il faut effectuer un marquage une fois par archive. La valeur par défaut est « false ».

flagOncePerFile Booléen Non

Indique s'il faut effectuer un marquage une fois par fichier. La valeur par défaut est « false ».

hideResult Booléen Non

Indique si les résultats marqués par cette règle doivent être masqués dans le rapport. Cet attribut masque uniquement les résultats lorsqu'il est utilisé avec des règles sous les balises < and> ou < or>. La valeur par défaut est « false ».

Par exemple, pour détecter la méthode load à partir de la classe java.util.Properties avec n'importe quelle signature de méthode, spécifiez :


<detectMethod name="load" owners="java.util.Properties"/>