org.codenarc.rule.size
Class CrapMetricRule

java.lang.Object
  extended by org.codenarc.rule.AbstractRule
      extended by org.codenarc.rule.AbstractAstVisitorRule
          extended by org.codenarc.rule.size.CrapMetricRule
All Implemented Interfaces:
groovy.lang.GroovyObject, Rule

public class CrapMetricRule
extends AbstractAstVisitorRule
implements groovy.lang.GroovyObject


Field Summary
protected  String crapMetricClassName
           
 
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
CrapMetricRule()
           
 
Method Summary
 AstVisitor getAstVisitor()
           
 String getCoberturaXmlFile()
           
 String getIgnoreMethodNames()
           
 BigDecimal getMaxClassAverageMethodCrapScore()
           
 BigDecimal getMaxMethodCrapScore()
           
 groovy.lang.MetaClass getMetaClass()
           
 String getName()
           
 int getPriority()
           
 Object getProperty(String property)
           
 Object invokeMethod(String method, Object arguments)
           
 boolean isReady()
          Allows rules to check whether preconditions are satisfied and short-circuit execution (i.e., do nothing) if those preconditions are not satisfied.
 void setCoberturaXmlFile(String value)
           
 void setIgnoreMethodNames(String value)
           
 void setMaxClassAverageMethodCrapScore(BigDecimal value)
           
 void setMaxMethodCrapScore(BigDecimal 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.AbstractAstVisitorRule
applyTo, getApplyToClassNames, 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, 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
 

Field Detail

crapMetricClassName

protected String crapMetricClassName
Constructor Detail

CrapMetricRule

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

getMaxMethodCrapScore

public BigDecimal getMaxMethodCrapScore()

setMaxMethodCrapScore

public void setMaxMethodCrapScore(BigDecimal value)

getMaxClassAverageMethodCrapScore

public BigDecimal getMaxClassAverageMethodCrapScore()

setMaxClassAverageMethodCrapScore

public void setMaxClassAverageMethodCrapScore(BigDecimal value)

getCoberturaXmlFile

public String getCoberturaXmlFile()

setCoberturaXmlFile

public void setCoberturaXmlFile(String value)

getIgnoreMethodNames

public String getIgnoreMethodNames()

setIgnoreMethodNames

public void setIgnoreMethodNames(String value)

getAstVisitor

public AstVisitor getAstVisitor()
Overrides:
getAstVisitor in class AbstractAstVisitorRule

isReady

public boolean isReady()
Description copied from class: AbstractRule
Allows rules to check whether preconditions are satisfied and short-circuit execution (i.e., do nothing) if those preconditions are not satisfied. Return true by default. This method is provided as a placeholder so subclasses can optionally override.

Overrides:
isReady in class AbstractRule
Returns:
true if all preconditions for this rule are satisfied


Copyright © 2012. All Rights Reserved.