class GrailsPublicControllerMethodRule extends AbstractAstVisitorRule
Rule that checks for public methods on Grails controller classes. Static methods are ignored.
NOTE: This rule is DISABLED by default (i.e., by setting its enabled property to false). Given that Grails 2.x allows and encourages controller actions to be defined as methods instead of closures, this rule makes no more sense (for Grails 2.x projects). 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. | 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.String |
applyToClassNames |
java.lang.String |
applyToFilesMatching |
java.lang.Class |
astVisitorClass |
java.lang.String |
ignoreMethodNames |
java.lang.String |
name |
int |
priority |
| Constructor and description |
|---|
GrailsPublicControllerMethodRule
() |
Groovy Documentation