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 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 namebooleangroovy.lang.MetaClassgetName()intgetProperty(String property) getViolations(AstVisitor visitor, SourceCode sourceCode) invokeMethod(String method, Object arguments) booleanisDefinedInJpaEntity(org.codehaus.groovy.ast.FieldNode fieldNode) booleanvoidsetAstVisitorClass(Class value) voidsetIgnoreFieldNames(String value) voidsetIgnoreJpaEntities(boolean value) voidsetMetaClass(groovy.lang.MetaClass mc) voidSet the unique name for this rulevoidsetPriority(int value) Set the priority for this rulevoidsetProperty(String property, Object value) Methods inherited from class AbstractSharedAstVisitorRule
applyTo, applyVisitor, getAstVisitorMethods inherited from class AbstractAstVisitorRule
getApplyToClassNames, getAstVisitor, getDoNotApplyToClassNames, setApplyToClassNames, setDoNotApplyToClassNames, shouldApplyThisRuleToMethods inherited from class 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:
getMetaClassin interfacegroovy.lang.GroovyObject
-
setMetaClass
public void setMetaClass(groovy.lang.MetaClass mc) - Specified by:
setMetaClassin interfacegroovy.lang.GroovyObject
-
invokeMethod
-
getProperty
-
setProperty
-
getName
- Specified by:
getNamein interfaceRule- Specified by:
getNamein classAbstractRule- Returns:
- the unique name for this rule
-
setName
Description copied from class:AbstractRuleSet the unique name for this rule- Specified by:
setNamein classAbstractRule- Parameters:
value- - the name for this rule; this should be unique
-
getPriority
public int getPriority()- Specified by:
getPriorityin interfaceRule- Specified by:
getPriorityin 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:AbstractRuleSet the priority for this rule- Specified by:
setPriorityin 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:AbstractAstVisitorRuleEach concrete subclass must either set this property or define its own property with the same name- Overrides:
getAstVisitorClassin classAbstractAstVisitorRule
-
setAstVisitorClass
-
getViolations
- Specified by:
getViolationsin classAbstractSharedAstVisitorRule
-
isDefinedInJpaEntity
public boolean isDefinedInJpaEntity(org.codehaus.groovy.ast.FieldNode fieldNode)
-