org.codenarc.rule.naming
[Groovy] Class ParameterNameRule
java.lang.Object
org.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.
The regex
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 '?').
- Authors:
- Chris Mair
- Hamlet D'Arcy
- Version:
- \$Revision: 553 \$ - \$Date: 2011-01-20 16:07:46 -0500 (Thu, 20 Jan 2011) \$
Methods inherited from class AbstractRule
|
applyTo, applyTo, createViolation, createViolation, createViolationForImport, createViolationForImport, getImportsSortedByLineNumber, getName, getPriority, isReady, packageNameForImport, setName, setPriority, sourceLineAndNumberForImport, sourceLineAndNumberForImport, toString, validate |
astVisitorClass
Class astVisitorClass
-
ignoreParameterNames
String ignoreParameterNames
-
name
String name
-
priority
int priority
-
regex
String regex
-
validate
void validate()
-
Groovy Documentation