Package org.codenarc.rule.design
Class PrivateFieldCouldBeFinalRule
java.lang.Object
org.codenarc.rule.AbstractRule
org.codenarc.rule.AbstractAstVisitorRule
org.codenarc.rule.AbstractSharedAstVisitorRule
org.codenarc.rule.design.PrivateFieldCouldBeFinalRule
- All Implemented Interfaces:
groovy.lang.GroovyObject
,Rule
public class PrivateFieldCouldBeFinalRule
extends AbstractSharedAstVisitorRule
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 -
Method Summary
Modifier and TypeMethodDescriptionEach concrete subclass must either set this property or define its own property with the same nameboolean
groovy.lang.MetaClass
getName()
int
getProperty
(String property) getViolations
(AstVisitor visitor, SourceCode sourceCode) invokeMethod
(String method, Object arguments) boolean
isDefinedInJpaEntity
(org.codehaus.groovy.ast.FieldNode fieldNode) boolean
void
setAstVisitorClass
(Class value) void
setIgnoreFieldNames
(String value) void
setIgnoreJpaEntities
(boolean value) void
setMetaClass
(groovy.lang.MetaClass mc) void
Set the unique name for this rulevoid
setPriority
(int value) Set the priority for this rulevoid
setProperty
(String property, Object value) Methods inherited from class org.codenarc.rule.AbstractSharedAstVisitorRule
applyTo, applyVisitor, getAstVisitor
Methods inherited from class org.codenarc.rule.AbstractAstVisitorRule
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, isReady, setApplyToFileNames, setApplyToFilesMatching, setDescription, setDoNotApplyToFileNames, setDoNotApplyToFilesMatching, setEnabled, setViolationMessage, toString, validate
-
Constructor Details
-
PrivateFieldCouldBeFinalRule
public PrivateFieldCouldBeFinalRule()
-
-
Method Details
-
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
- Specified by:
invokeMethod
in interfacegroovy.lang.GroovyObject
-
getProperty
- Specified by:
getProperty
in interfacegroovy.lang.GroovyObject
-
setProperty
- Specified by:
setProperty
in interfacegroovy.lang.GroovyObject
-
getName
- Specified by:
getName
in interfaceRule
- Specified by:
getName
in classAbstractRule
- Returns:
- the unique name for this rule
-
setName
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
-
setIgnoreFieldNames
-
getIgnoreJpaEntities
public boolean getIgnoreJpaEntities() -
isIgnoreJpaEntities
public boolean isIgnoreJpaEntities() -
setIgnoreJpaEntities
public void setIgnoreJpaEntities(boolean value) -
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
-
getViolations
- Specified by:
getViolations
in classAbstractSharedAstVisitorRule
-
isDefinedInJpaEntity
public boolean isDefinedInJpaEntity(org.codehaus.groovy.ast.FieldNode fieldNode)
-