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

Class AbstractNcssCountRule

java.lang.Object

net.sourceforge.pmd.properties.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.AbstractNcssCountRule

All Implemented Interfaces:

JavaParserVisitor, ImmutableLanguage, StatisticalRule, PropertySource, Rule

Direct Known Subclasses:

NcssConstructorCountRule, NcssMethodCountRule, NcssTypeCountRule

public abstract class AbstractNcssCountRule
extends AbstractStatisticalJavaRule

Abstract superclass for NCSS counting methods. Counts tokens according to JavaNCSS rules.

Author:

Jason Bennett

Field Summary

Fields inherited from class net.sourceforge.pmd.properties.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

Constructors

Modifier	Constructor and Description
protected	AbstractNcssCountRule(java.lang.Class<?> nodeClass) Count the nodes of the given type using NCSS rules.

Method Summary

Modifier and Type	Method and Description
protected java.lang.Integer	countNodeChildren(Node node, java.lang.Object data) Count the number of children of the given Java node.
java.lang.Object	visit(ASTBreakStatement node, java.lang.Object data)
java.lang.Object	visit(ASTCatchStatement node, java.lang.Object data)
java.lang.Object	visit(ASTContinueStatement node, java.lang.Object data)
java.lang.Object	visit(ASTDoStatement node, java.lang.Object data)
java.lang.Object	visit(ASTFinallyStatement node, java.lang.Object data)
java.lang.Object	visit(ASTForStatement node, java.lang.Object data)
java.lang.Object	visit(ASTIfStatement node, java.lang.Object data)
java.lang.Object	visit(ASTLabeledStatement node, java.lang.Object data)
java.lang.Object	visit(ASTLocalVariableDeclaration node, java.lang.Object data)
java.lang.Object	visit(ASTReturnStatement node, java.lang.Object data)
java.lang.Object	visit(ASTStatementExpression node, java.lang.Object data)
java.lang.Object	visit(ASTSwitchLabel node, java.lang.Object data)
java.lang.Object	visit(ASTSwitchStatement node, java.lang.Object data)
java.lang.Object	visit(ASTSynchronizedStatement node, java.lang.Object data)
java.lang.Object	visit(ASTThrowStatement node, java.lang.Object data)
java.lang.Object	visit(ASTWhileStatement node, java.lang.Object data)
java.lang.Object	visit(JavaNode node, java.lang.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, visitAll

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

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

Methods inherited from class net.sourceforge.pmd.properties.AbstractPropertySource

copyPropertyDescriptors, copyPropertyValues, definePropertyDescriptor, dysfunctionReason, getPropertiesByPropertyDescriptor, getProperty, getPropertyDescriptor, getPropertyDescriptors, hasDescriptor, ignoredProperties, setProperty, 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, deepCopy, end, getDescription, getExamples, getExternalInfoUrl, getLanguage, getMaximumLanguageVersion, getMessage, getMinimumLanguageVersion, getName, getParserOptions, getPriority, getRuleChainVisits, getRuleClass, getRuleSetName, getSince, isDeprecated, isDfa, isMultifile, isRuleChain, isTypeResolution, setDeprecated, setDescription, setDfa, setExternalInfoUrl, setLanguage, setMaximumLanguageVersion, setMessage, setMinimumLanguageVersion, setMultifile, setName, setPriority, setRuleClass, setRuleSetName, setSince, setTypeResolution, setUsesDFA, setUsesMultifile, setUsesTypeResolution, start, usesDFA, usesMultifile, usesRuleChain, usesTypeResolution

Methods inherited from interface net.sourceforge.pmd.properties.PropertySource

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

Constructor Detail

AbstractNcssCountRule

protected AbstractNcssCountRule(java.lang.Class<?> nodeClass)

Count the nodes of the given type using NCSS rules.

Parameters:

nodeClass - class of node to count

Method Detail

visit

public java.lang.Object visit(JavaNode node,
                              java.lang.Object data)

Specified by:

visit in interface JavaParserVisitor

Overrides:

visit in class AbstractJavaRule

countNodeChildren

protected java.lang.Integer countNodeChildren(Node node,
                                              java.lang.Object data)

Count the number of children of the given Java node. Adds one to count the node itself.

Parameters:

node - java node having children counted

data - node data

Returns:

count of the number of children of the node, plus one

visit

public java.lang.Object visit(ASTForStatement node,
                              java.lang.Object data)

Specified by:

visit in interface JavaParserVisitor

Overrides:

visit in class AbstractJavaRule

visit

public java.lang.Object visit(ASTDoStatement node,
                              java.lang.Object data)

Specified by:

visit in interface JavaParserVisitor

Overrides:

visit in class AbstractJavaRule

visit

public java.lang.Object visit(ASTIfStatement node,
                              java.lang.Object data)

Specified by:

visit in interface JavaParserVisitor

Overrides:

visit in class AbstractJavaRule

visit

public java.lang.Object visit(ASTWhileStatement node,
                              java.lang.Object data)

Specified by:

visit in interface JavaParserVisitor

Overrides:

visit in class AbstractJavaRule

visit

public java.lang.Object visit(ASTBreakStatement node,
                              java.lang.Object data)

Specified by:

visit in interface JavaParserVisitor

Overrides:

visit in class AbstractJavaRule

visit

public java.lang.Object visit(ASTCatchStatement node,
                              java.lang.Object data)

Specified by:

visit in interface JavaParserVisitor

Overrides:

visit in class AbstractJavaRule

visit

public java.lang.Object visit(ASTContinueStatement node,
                              java.lang.Object data)

Specified by:

visit in interface JavaParserVisitor

Overrides:

visit in class AbstractJavaRule

visit

public java.lang.Object visit(ASTFinallyStatement node,
                              java.lang.Object data)

Specified by:

visit in interface JavaParserVisitor

Overrides:

visit in class AbstractJavaRule

visit

public java.lang.Object visit(ASTReturnStatement node,
                              java.lang.Object data)

Specified by:

visit in interface JavaParserVisitor

Overrides:

visit in class AbstractJavaRule

visit

public java.lang.Object visit(ASTSwitchStatement node,
                              java.lang.Object data)

Specified by:

visit in interface JavaParserVisitor

Overrides:

visit in class AbstractJavaRule

visit

public java.lang.Object visit(ASTSynchronizedStatement node,
                              java.lang.Object data)

Specified by:

visit in interface JavaParserVisitor

Overrides:

visit in class AbstractJavaRule

visit

public java.lang.Object visit(ASTThrowStatement node,
                              java.lang.Object data)

Specified by:

visit in interface JavaParserVisitor

Overrides:

visit in class AbstractJavaRule

visit

public java.lang.Object visit(ASTStatementExpression node,
                              java.lang.Object data)

Specified by:

visit in interface JavaParserVisitor

Overrides:

visit in class AbstractJavaRule

visit

public java.lang.Object visit(ASTLabeledStatement node,
                              java.lang.Object data)

Specified by:

visit in interface JavaParserVisitor

Overrides:

visit in class AbstractJavaRule

visit

public java.lang.Object visit(ASTLocalVariableDeclaration node,
                              java.lang.Object data)

Specified by:

visit in interface JavaParserVisitor

Overrides:

visit in class AbstractJavaRule

visit

public java.lang.Object visit(ASTSwitchLabel node,
                              java.lang.Object data)

Specified by:

visit in interface JavaParserVisitor

Overrides:

visit in class AbstractJavaRule