Package org.codenarc.rule.generic
Class StatelessClassRule
- java.lang.Object
-
- org.codenarc.rule.AbstractRule
-
- org.codenarc.rule.AbstractAstVisitorRule
-
- org.codenarc.rule.generic.StatelessClassRule
-
- All Implemented Interfaces:
groovy.lang.GroovyObject
,Rule
- Direct Known Subclasses:
GrailsStatelessServiceRule
public class StatelessClassRule extends AbstractAstVisitorRule implements groovy.lang.GroovyObject
-
-
Field Summary
-
Fields inherited from class org.codenarc.rule.AbstractAstVisitorRule
CLOSURE_TEXT, DEFAULT_CONST_NAME, DEFAULT_FIELD_NAME, DEFAULT_TEST_CLASS_NAMES, DEFAULT_TEST_FILES, DEFAULT_VAR_NAME
-
-
Constructor Summary
Constructors Constructor Description StatelessClassRule()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Class
getAstVisitorClass()
Each concrete subclass must either set this property or define its own property with the same nameString
getIgnoreFieldNames()
String
getIgnoreFieldTypes()
groovy.lang.MetaClass
getMetaClass()
String
getName()
int
getPriority()
Object
getProperty(String property)
Object
invokeMethod(String method, Object arguments)
boolean
isReady()
Allows rules to check whether preconditions are satisfied and short-circuit execution (i.e., do nothing) if those preconditions are not satisfied.void
setAddToIgnoreFieldNames(String moreFieldNames)
void
setAstVisitorClass(Class value)
void
setIgnoreFieldNames(String value)
void
setIgnoreFieldTypes(String value)
void
setMetaClass(groovy.lang.MetaClass mc)
void
setName(String value)
Set the unique name for this rulevoid
setPriority(int value)
Set the priority for this rulevoid
setProperty(String property, Object value)
protected boolean
shouldIgnoreField(org.codehaus.groovy.ast.FieldNode fieldNode)
-
Methods inherited from class org.codenarc.rule.AbstractAstVisitorRule
applyTo, getApplyToClassNames, getAstVisitor, getDoNotApplyToClassNames, setApplyToClassNames, setDoNotApplyToClassNames, shouldApplyThisRuleTo
-
Methods inherited from class org.codenarc.rule.AbstractRule
applyTo, createViolation, createViolation, createViolationForImport, createViolationForImport, getApplyToFileNames, getApplyToFilesMatching, getCompilerPhase, getDescription, getDoNotApplyToFileNames, getDoNotApplyToFilesMatching, getViolationMessage, isEnabled, setApplyToFileNames, setApplyToFilesMatching, setDescription, setDoNotApplyToFileNames, setDoNotApplyToFilesMatching, setEnabled, setViolationMessage, toString, validate
-
-
-
-
Method Detail
-
getMetaClass
public groovy.lang.MetaClass getMetaClass()
- Specified by:
getMetaClass
in interfacegroovy.lang.GroovyObject
-
setMetaClass
public void setMetaClass(groovy.lang.MetaClass mc)
- Specified by:
setMetaClass
in interfacegroovy.lang.GroovyObject
-
invokeMethod
public Object invokeMethod(String method, Object arguments)
- Specified by:
invokeMethod
in interfacegroovy.lang.GroovyObject
-
getProperty
public Object getProperty(String property)
- Specified by:
getProperty
in interfacegroovy.lang.GroovyObject
-
setProperty
public void setProperty(String property, Object value)
- Specified by:
setProperty
in interfacegroovy.lang.GroovyObject
-
getName
public String getName()
- Specified by:
getName
in interfaceRule
- Specified by:
getName
in classAbstractRule
- Returns:
- the unique name for this rule
-
setName
public void setName(String value)
Description copied from class:AbstractRule
Set the unique name for this rule- Specified by:
setName
in classAbstractRule
- Parameters:
value
- - the name for this rule; this should be unique
-
getPriority
public int getPriority()
- Specified by:
getPriority
in interfaceRule
- Specified by:
getPriority
in classAbstractRule
- Returns:
- the priority of this rule, between 1 (highest priority) and 3 (lowest priority), inclusive.
-
setPriority
public void setPriority(int value)
Description copied from class:AbstractRule
Set the priority for this rule- Specified by:
setPriority
in classAbstractRule
- Parameters:
value
- - the priority of this rule, between 1 (highest priority) and 3 (lowest priority), inclusive.
-
getIgnoreFieldNames
public String getIgnoreFieldNames()
-
setIgnoreFieldNames
public void setIgnoreFieldNames(String value)
-
getIgnoreFieldTypes
public String getIgnoreFieldTypes()
-
setIgnoreFieldTypes
public void setIgnoreFieldTypes(String value)
-
getAstVisitorClass
public Class getAstVisitorClass()
Description copied from class:AbstractAstVisitorRule
Each concrete subclass must either set this property or define its own property with the same name- Overrides:
getAstVisitorClass
in classAbstractAstVisitorRule
-
setAstVisitorClass
public void setAstVisitorClass(Class value)
-
isReady
public boolean isReady()
Description copied from class:AbstractRule
Allows rules to check whether preconditions are satisfied and short-circuit execution (i.e., do nothing) if those preconditions are not satisfied. Return true by default. This method is provided as a placeholder so subclasses can optionally override.- Overrides:
isReady
in classAbstractRule
- Returns:
- true if all preconditions for this rule are satisfied
-
setAddToIgnoreFieldNames
public void setAddToIgnoreFieldNames(String moreFieldNames)
-
shouldIgnoreField
protected boolean shouldIgnoreField(org.codehaus.groovy.ast.FieldNode fieldNode)
-
-