net.sourceforge.pmd.lang.java.rule.design
Class ExcessiveNodeCountRule

java.lang.Object
  net.sourceforge.pmd.AbstractPropertySource
      net.sourceforge.pmd.lang.rule.AbstractRule
          net.sourceforge.pmd.lang.java.rule.AbstractJavaRule
              net.sourceforge.pmd.lang.java.rule.AbstractStatisticalJavaRule
                  net.sourceforge.pmd.lang.java.rule.design.ExcessiveNodeCountRule

All Implemented Interfaces:

JavaParserVisitor, ImmutableLanguage, StatisticalRule, PropertySource, Rule

Direct Known Subclasses:

ExcessiveImportsRule, ExcessiveParameterListRule, ExcessivePublicCountRule

public class ExcessiveNodeCountRule
extends AbstractStatisticalJavaRule

This is a common super class for things which shouldn't have excessive nodes underneath.

It expects all "visit" calls to return an Integer. It will sum all the values it gets, and use that as its score.

To use it, override the "visit" for the nodes that need to be counted. On those return "new Integer(1)"

All others will return 0 (or the sum of counted nodes underneath.)

Field Summary

Fields inherited from class net.sourceforge.pmd.AbstractPropertySource

propertyDescriptors, propertyValuesByDescriptor

Fields inherited from interface net.sourceforge.pmd.lang.rule.stat.StatisticalRule

MINIMUM_DESCRIPTOR, SIGMA_DESCRIPTOR, TOP_SCORE_DESCRIPTOR

Fields inherited from interface net.sourceforge.pmd.Rule

VIOLATION_SUPPRESS_REGEX_DESCRIPTOR, VIOLATION_SUPPRESS_XPATH_DESCRIPTOR

Constructor Summary

ExcessiveNodeCountRule(Class<?> nodeClass)

Method Summary

Object

visit(JavaNode node, Object data)

Methods inherited from class net.sourceforge.pmd.lang.java.rule.AbstractStatisticalJavaRule

addDataPoint, apply, getViolationParameters

Methods inherited from class net.sourceforge.pmd.lang.java.rule.AbstractJavaRule

getDeclaringType, importsPackage, isQualifiedName, isSuppressed, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visitAll

Methods inherited from class net.sourceforge.pmd.lang.rule.AbstractRule

addExample, addRuleChainVisit, addRuleChainVisit, addViolation, addViolation, addViolation, addViolationWithMessage, addViolationWithMessage, addViolationWithMessage, deepCopyValuesTo, end, equals, getDescription, getExamples, getExternalInfoUrl, getLanguage, getMaximumLanguageVersion, getMessage, getMinimumLanguageVersion, getName, getParserOptions, getPriority, getRuleChainVisits, getRuleClass, getRuleSetName, getSince, hashCode, isDeprecated, setDeprecated, setDescription, setExternalInfoUrl, setLanguage, setMaximumLanguageVersion, setMessage, setMinimumLanguageVersion, setName, setPriority, setRuleClass, setRuleSetName, setSince, setUsesDFA, setUsesTypeResolution, start, usesDFA, usesRuleChain, usesTypeResolution

Methods inherited from class net.sourceforge.pmd.AbstractPropertySource

copyPropertyDescriptors, copyPropertyValues, definePropertyDescriptor, dysfunctionReason, getPropertiesByPropertyDescriptor, getProperty, getPropertyDescriptor, getPropertyDescriptors, hasDescriptor, ignoredProperties, setProperty, useDefaultValueFor, usesDefaultValues

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.sourceforge.pmd.Rule

addExample, addRuleChainVisit, addRuleChainVisit, end, getDescription, getExamples, getExternalInfoUrl, getLanguage, getMaximumLanguageVersion, getMessage, getMinimumLanguageVersion, getName, getParserOptions, getPriority, getRuleChainVisits, getRuleClass, getRuleSetName, getSince, isDeprecated, setDeprecated, setDescription, setExternalInfoUrl, setLanguage, setMaximumLanguageVersion, setMessage, setMinimumLanguageVersion, setName, setPriority, setRuleClass, setRuleSetName, setSince, setUsesDFA, setUsesTypeResolution, start, usesDFA, usesRuleChain, usesTypeResolution

Methods inherited from interface net.sourceforge.pmd.PropertySource

definePropertyDescriptor, dysfunctionReason, getPropertiesByPropertyDescriptor, getProperty, getPropertyDescriptor, getPropertyDescriptors, hasDescriptor, ignoredProperties, setProperty, useDefaultValueFor, usesDefaultValues

Constructor Detail

ExcessiveNodeCountRule

public ExcessiveNodeCountRule(Class<?> nodeClass)

Method Detail

visit

public Object visit(JavaNode node,
                    Object data)

Specified by:

visit in interface JavaParserVisitor

Overrides:

visit in class AbstractJavaRule