|
Groovy Documentation | |||||||
FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | PROPERTY | CONSTR | METHOD | DETAIL: FIELD | PROPERTY | CONSTR | METHOD |
java.lang.Objectorg.codenarc.rule.AbstractRule
org.codenarc.rule.AbstractAstVisitorRule
org.codenarc.rule.naming.ParameterNameRule
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 '?').
Property Summary | |
---|---|
Class |
astVisitorClass
|
String |
ignoreParameterNames
|
String |
name
|
int |
priority
|
String |
regex
|
Constructor Summary | |
ParameterNameRule()
|
Method Summary | |
---|---|
void
|
validate()
|
Methods inherited from class AbstractAstVisitorRule | |
---|---|
shouldApplyThisRuleTo |
Property Detail |
---|
Class astVisitorClass
String ignoreParameterNames
String name
int priority
String regex
Constructor Detail |
---|
ParameterNameRule()
Method Detail |
---|
void validate()
Groovy Documentation