|
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.grails.GrailsPublicControllerMethodRule
class GrailsPublicControllerMethodRule extends AbstractAstVisitorRule
Rule that checks for public methods on Grails controller classes. Static methods are ignored.
Grails controller actions and interceptors are defined as properties on the controller class. Public methods on a controller class are unnecessary. They break encapsulation and can be confusing. TheignoreMethodNames
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 '?').
This rule sets the default value of applyToFilesMatching
to only match files
under the 'grails-app/controllers' folder. You can override this with a different regular
expression value if appropriate.
This rule also sets the default value of applyToClassNames
to only match class
names ending in 'Controller'. You can override this with a different class name pattern
(String) if appropriate.
Field Summary |
---|
Fields inherited from class AbstractAstVisitorRule | |
---|---|
DEFAULT_CONST_NAME, DEFAULT_FIELD_NAME, DEFAULT_TEST_CLASS_NAMES, DEFAULT_TEST_FILES, DEFAULT_VAR_NAME |
Property Summary | |
---|---|
String |
applyToClassNames
|
String |
applyToFilesMatching
|
Class |
astVisitorClass
|
String |
ignoreMethodNames
|
String |
name
|
int |
priority
|
Method Summary |
---|
Methods inherited from class AbstractAstVisitorRule | |
---|---|
applyTo, getAstVisitor, shouldApplyThisRuleTo |
Property Detail |
---|
String applyToClassNames
String applyToFilesMatching
Class astVisitorClass
String ignoreMethodNames
String name
int priority
Groovy Documentation