org.codenarc.rule.unused
Class UnusedPrivateMethodRule

java.lang.Object
  extended by org.codenarc.rule.AbstractRule
      extended by org.codenarc.rule.AbstractAstVisitorRule
          extended by org.codenarc.rule.AbstractSharedAstVisitorRule
              extended by org.codenarc.rule.unused.UnusedPrivateMethodRule
All Implemented Interfaces:
groovy.lang.GroovyObject, Rule

public class UnusedPrivateMethodRule
extends AbstractSharedAstVisitorRule
implements groovy.lang.GroovyObject


Field Summary
 
Fields inherited from class org.codenarc.rule.AbstractAstVisitorRule
DEFAULT_CONST_NAME, DEFAULT_FIELD_NAME, DEFAULT_TEST_CLASS_NAMES, DEFAULT_TEST_FILES, DEFAULT_VAR_NAME
 
Constructor Summary
UnusedPrivateMethodRule()
           
 
Method Summary
protected  AstVisitor getAstVisitor(SourceCode sourceCode)
          Subclasses can override to provide an AstVisitor with SourceCode or AST-specific initialization.
 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)
           
 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
 
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, createViolation, createViolation, createViolation, createViolationForImport, createViolationForImport, createViolationForImport, getApplyToFileNames, getApplyToFilesMatching, 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

UnusedPrivateMethodRule

public UnusedPrivateMethodRule()
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.

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

getViolations

protected List<Violation> getViolations(AstVisitor visitor,
                                        SourceCode sourceCode)
Specified by:
getViolations in class AbstractSharedAstVisitorRule


Copyright © 2012. All Rights Reserved.