class ParameterNameRule extends AbstractAstVisitorRule
Rule that verifies that the name of each parameter matches a regular expression. This rule applies to method parameters, constructor parameters and closure parameters. By default it checks that parameter names start with a lowercase letter and contains only letters or numbers.
Theregex
property specifies the default regular expression used to validate the
parameter name. It is required and cannot be null or empty. It defaults to '[a-z][a-zA-Z0-9]*'.
The ignoreParameterNames
property optionally specifies one or more
(comma-separated) parameter names that should be ignored (i.e., that should not cause a
rule violation). The name(s) may optionally include wildcard characters ('*' or '?'). Fields inherited from class | Fields |
---|---|
class AbstractAstVisitorRule |
CLOSURE_TEXT, DEFAULT_CONST_NAME, DEFAULT_FIELD_NAME, DEFAULT_TEST_CLASS_NAMES, DEFAULT_TEST_FILES, DEFAULT_VAR_NAME |
Type | Name and description |
---|---|
java.lang.Class |
astVisitorClass |
java.lang.String |
ignoreParameterNames |
java.lang.String |
name |
int |
priority |
java.lang.String |
regex |
Constructor and description |
---|
ParameterNameRule
() |
Type Params | Return Type | Name and description |
---|---|---|
|
void |
validate() |
Groovy Documentation