Methodenparameter erkennen (detectMethodParameter)
Element <detectMethodParameter>
Die Regel detectMethodParameter wird für zum Finden von Methodenparametern in Java-Klassen verwendet.
| Attributname | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| Name | Zeichenfolge | Ja | Der Name der Methode. |
| Eigner | Zeichenfolge | Ja | Der vollständig qualifizierte Klassenname der Klasse, in der die Methode definiert ist. Wenn Sie mehrere angeben, verwenden Sie eine durch Kommas getrennte Liste. |
| returnType | Zeichenfolge | Nein | Der vollständig qualifizierte Klassenname des Rückgabetyps. |
| arguments | Zeichenfolge | Nein | Die vollständig qualifizierten Klassennamen oder Basiselemente der Methodenargumente. Wenn Sie mehrere angeben, verwenden Sie eine durch Kommas getrennte Liste. Geben Sie eine leere Zeichenfolge an, um die Methode ohne Parameter zu markieren. Wenn nicht angegeben, markieren Sie alle Methodensignaturen. |
| flagCatchExceptions | Zeichenfolge | Nein | Die vollständig qualifizierten Klassennamen der Ausnahmen. Wenn Sie mehrere angeben, verwenden Sie eine durch Kommas getrennte Liste. Flag ruft die Methode auf, wenn es innerhalb eines Try- und Catch-Blocks für eine der angegebenen Ausnahmen ist. |
| flagUnhandledExceptions | Zeichenfolge | Nein | Vollständig qualifizierte Klassennamen der Ausnahmen. Wenn Sie mehrere angeben, verwenden Sie eine durch Kommas getrennte Liste. Flag ruft die Methode auf, wenn keine der angegebenen Ausnahmen von der aufrufenden Methode abgefangen oder ausgelöst wird. |
| flagOnce | boolesch | Nein | Gibt an, ob einmal pro Archiv markiert werden soll. Standardwerte auf "false". |
| flagOncePerFile | boolesch | Nein | Gibt an, ob einmal pro Datei markiert werden soll. Standardwerte auf "false". |
| hideResult | boolesch | Nein | Gibt an, ob die von dieser Regel markierten Ergebnisse im Bericht ausgeblendet werden. Dieses Attribut blendet Ergebnisse nur aus, wenn es mit Regeln unter den Tags < and> oder < or> verwendet wird. Standardwerte auf "false". |
Untergeordnete Elemente (Eins oder mehrere)
Element &lt;argument> - erforderlich, kann mehrere sein
| Attributname | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| Lage | Ganzzahl | Ja | Die Position des Arguments, beginnend mit 0. |
| flagVariable | boolesch | Nein | Gibt an, ob eine Variable für diese Argumentposition markiert werden soll oder nicht. Standardwerte auf "false". |
| flagStringLiteral | Regex | Nein | Markieren Sie, ob dieser Zeichenfolgenliteralwert für diesen Methodenparameter angegeben wird. |
| flagVariableValue | Regex | Nein | Markieren, wenn dieser Variablenwert für diesen Methodenparameter angegeben wird. |
| flagType | Zeichenfolge | Nein | Ein vollständig qualifizierter Klassenname. Verwenden Sie diese Option, wenn Sie einen bestimmten Typ markieren müssen, aber das Methodenargument generischer ist, z. B. java.lang.Object. |
| flagTypeLiteral | boolesch | Nein | Gibt an, ob eine Übereinstimmung mit einem Typliteral, z. B. "someClass.class", erfolgen soll. Standardwerte auf "false". |
Um beispielsweise eine createSession-Methode für die Klasse javax.jms.Connection mit einem int-Parameter zu finden, der mit einem Zeichenfolgeliteral oder einem Variablenwert von 0 angegeben wird, geben Sie Folgendes an:
<detectMethodParameter name="createSession" arguments="int" owners="javax.jms.Connection">
<argument position="0" flagVariable="true" flagVariableValue="0" flagStringLiteral="0"/>
</detectMethodParameter>