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

Constructor	Description
PrivateFieldCouldBeFinalRule()

Method Summary

Modifier and Type	Method	Description
Class	getAstVisitorClass()	Each concrete subclass must either set this property or define its own property with the same name
String	getIgnoreFieldNames()
boolean	getIgnoreJpaEntities()
groovy.lang.MetaClass	getMetaClass()
String	getName()
int	getPriority()
Object	getProperty(String property)
protected List<Violation>	getViolations(AstVisitor visitor, SourceCode sourceCode)
Object	invokeMethod(String method, Object arguments)
boolean	isDefinedInJpaEntity(org.codehaus.groovy.ast.FieldNode fieldNode)
boolean	isIgnoreJpaEntities()
void	setAstVisitorClass(Class value)
void	setIgnoreFieldNames(String value)
void	setIgnoreJpaEntities(boolean value)
void	setMetaClass(groovy.lang.MetaClass mc)
void	setName(String value)	Set the unique name for this rule
void	setPriority(int value)	Set the priority for this rule
void	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, createViolation, createViolation, createViolation, createViolationForImport, createViolationForImport, createViolationForImport, getApplyToFileNames, getApplyToFilesMatching, getCompilerPhase, getDescription, getDoNotApplyToFileNames, getDoNotApplyToFilesMatching, getViolationMessage, isEnabled, isReady, setApplyToFileNames, setApplyToFilesMatching, setDescription, setDoNotApplyToFileNames, setDoNotApplyToFilesMatching, setEnabled, setViolationMessage, toString, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PrivateFieldCouldBeFinalRule

public PrivateFieldCouldBeFinalRule()

Method Detail

getMetaClass

public groovy.lang.MetaClass getMetaClass()

Specified by:

getMetaClass in interface groovy.lang.GroovyObject

setMetaClass

public void setMetaClass(groovy.lang.MetaClass mc)

Specified by:

setMetaClass in interface groovy.lang.GroovyObject

invokeMethod

public Object invokeMethod(String method,
                           Object arguments)

Specified by:

invokeMethod in interface groovy.lang.GroovyObject

getProperty

public Object getProperty(String property)

Specified by:

getProperty in interface groovy.lang.GroovyObject

setProperty

public void setProperty(String property,
                        Object value)

Specified by:

setProperty in interface groovy.lang.GroovyObject

getName

public String getName()

Specified by:

getName in interface Rule

Specified by:

getName in class AbstractRule

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 class AbstractRule

Parameters:

value - - the name for this rule; this should be unique

getPriority

public int getPriority()

Specified by:

getPriority in interface Rule

Specified by:

getPriority in class AbstractRule

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 class AbstractRule

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)

getIgnoreJpaEntities

public boolean getIgnoreJpaEntities()

isIgnoreJpaEntities

public boolean isIgnoreJpaEntities()

setIgnoreJpaEntities

public void setIgnoreJpaEntities(boolean 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 class AbstractAstVisitorRule

setAstVisitorClass

public void setAstVisitorClass(Class value)

getViolations

protected List<Violation> getViolations(AstVisitor visitor,
                                        SourceCode sourceCode)

Specified by:

getViolations in class AbstractSharedAstVisitorRule

isDefinedInJpaEntity

public boolean isDefinedInJpaEntity(org.codehaus.groovy.ast.FieldNode fieldNode)