org.codenarc.rule.naming
[Groovy] Class MethodNameRule
java.lang.Object
org.codenarc.rule.AbstractRule
org.codenarc.rule.AbstractAstVisitorRule
org.codenarc.rule.naming.MethodNameRule
class MethodNameRule
extends AbstractAstVisitorRule
Rule that verifies that the name of each method matches a regular expression. By default it checks that the
method name starts with a lowercase letter. Implicit method names are ignored (i.e., 'main' and 'run'
methods automatically created for Groovy scripts).
The regex
property specifies the regular expression to check the method name against. It is
required and cannot be null or empty. It defaults to '[a-z]\w*'.
The ignoreMethodNames
property optionally specifies one or more
(comma-separated) method 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
-
ignoreMethodNames
String ignoreMethodNames
-
name
String name
-
priority
int priority
-
regex
String regex
-
Groovy Documentation