Package net.sourceforge.pmd.lang.java.rule

Class AbstractInefficientZeroCheck

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.AbstractInefficientZeroCheck

All Implemented Interfaces:

JavaParserVisitor, net.sourceforge.pmd.lang.rule.ImmutableLanguage, net.sourceforge.pmd.properties.PropertySource, net.sourceforge.pmd.Rule

Direct Known Subclasses:

InefficientEmptyStringCheckRule, UseCollectionIsEmptyRule

public abstract class AbstractInefficientZeroCheck
extends AbstractJavaRule

This is an abstract rule for patterns which compare a method invocation to 0. It could be further abstracted to find code that compares something to another definable pattern

Author:

acaplan

Field Summary

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

propertyDescriptors, propertyValuesByDescriptor

Fields inherited from interface net.sourceforge.pmd.Rule

VIOLATION_SUPPRESS_REGEX_DESCRIPTOR, VIOLATION_SUPPRESS_XPATH_DESCRIPTOR

Constructor Summary

Constructors

Constructor	Description
AbstractInefficientZeroCheck()

Method Summary

Modifier and Type	Method	Description
abstract boolean	appliesToClassName(java.lang.String name)
protected void	checkNodeAndReport(java.lang.Object data, net.sourceforge.pmd.lang.ast.Node location, net.sourceforge.pmd.lang.ast.Node expr)	Checks whether the given expression is a equality/relation expression that compares with a size() call.
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getComparisonTargets()	For each relation/equality operator, comparison targets need to define.
abstract boolean	isTargetMethod(JavaNameOccurrence occ)
java.lang.Object	visit(ASTVariableDeclaratorId node, java.lang.Object data)

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

apply, 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, 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, getPropertySourceType, 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, getOverriddenPropertiesByPropertyDescriptor, getOverriddenPropertyDescriptors, getPropertiesByPropertyDescriptor, getProperty, getPropertyDescriptor, getPropertyDescriptors, hasDescriptor, ignoredProperties, isPropertyOverridden, 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.properties.PropertySource

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

Constructor Detail

AbstractInefficientZeroCheck

public AbstractInefficientZeroCheck()

Method Detail

appliesToClassName

public abstract boolean appliesToClassName(java.lang.String name)

isTargetMethod

public abstract boolean isTargetMethod(JavaNameOccurrence occ)

getComparisonTargets

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getComparisonTargets()

For each relation/equality operator, comparison targets need to define.

Returns:

map

visit

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

Specified by:

visit in interface JavaParserVisitor

Overrides:

visit in class AbstractJavaRule

checkNodeAndReport

protected void checkNodeAndReport(java.lang.Object data,
                                  net.sourceforge.pmd.lang.ast.Node location,
                                  net.sourceforge.pmd.lang.ast.Node expr)

Checks whether the given expression is a equality/relation expression that compares with a size() call.

Parameters:

data - the rule context

location - the node location to report

expr - the ==, <, > expression