Package org.codenarc.rule.unused
Class UnusedPrivateFieldRule
- java.lang.Object
-
- org.codenarc.rule.AbstractRule
-
- org.codenarc.rule.AbstractAstVisitorRule
-
- org.codenarc.rule.AbstractSharedAstVisitorRule
-
- org.codenarc.rule.unused.UnusedPrivateFieldRule
-
- All Implemented Interfaces:
groovy.lang.GroovyObject
,Rule
public class UnusedPrivateFieldRule 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 UnusedPrivateFieldRule()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected AstVisitor
getAstVisitor(SourceCode sourceCode)
Subclasses can override to provide an AstVisitor with SourceCode or AST-specific initialization.java.lang.String
getIgnoreFieldNames()
groovy.lang.MetaClass
getMetaClass()
java.lang.String
getName()
int
getPriority()
java.lang.Object
getProperty(java.lang.String property)
protected java.util.List<Violation>
getViolations(AstVisitor visitor, SourceCode sourceCode)
java.lang.Object
invokeMethod(java.lang.String method, java.lang.Object arguments)
void
setIgnoreFieldNames(java.lang.String value)
void
setMetaClass(groovy.lang.MetaClass mc)
void
setName(java.lang.String value)
Set the unique name for this rulevoid
setPriority(int value)
Set the priority for this rulevoid
setProperty(java.lang.String property, java.lang.Object value)
-
Methods inherited from class org.codenarc.rule.AbstractSharedAstVisitorRule
applyTo, applyVisitor
-
Methods inherited from class org.codenarc.rule.AbstractAstVisitorRule
getApplyToClassNames, getAstVisitor, getAstVisitorClass, 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
-
-
-
-
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 java.lang.Object invokeMethod(java.lang.String method, java.lang.Object arguments)
- Specified by:
invokeMethod
in interfacegroovy.lang.GroovyObject
-
getProperty
public java.lang.Object getProperty(java.lang.String property)
- Specified by:
getProperty
in interfacegroovy.lang.GroovyObject
-
setProperty
public void setProperty(java.lang.String property, java.lang.Object value)
- Specified by:
setProperty
in interfacegroovy.lang.GroovyObject
-
getName
public java.lang.String getName()
- Specified by:
getName
in interfaceRule
- Specified by:
getName
in classAbstractRule
- Returns:
- the unique name for this rule
-
setName
public void setName(java.lang.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 java.lang.String getIgnoreFieldNames()
-
setIgnoreFieldNames
public void setIgnoreFieldNames(java.lang.String value)
-
getAstVisitor
protected AstVisitor getAstVisitor(SourceCode sourceCode)
Description copied from class:AbstractSharedAstVisitorRule
Subclasses can override to provide an AstVisitor with SourceCode or AST-specific initialization.- Overrides:
getAstVisitor
in classAbstractSharedAstVisitorRule
-
getViolations
protected java.util.List<Violation> getViolations(AstVisitor visitor, SourceCode sourceCode)
- Specified by:
getViolations
in classAbstractSharedAstVisitorRule
-
-