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

Class OverrideBothEqualsAndHashCodeOnComparableRule

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

net.sourceforge.pmd.lang.java.rule.errorprone.OverrideBothEqualsAndHashcodeRule

net.sourceforge.pmd.lang.java.rule.errorprone.OverrideBothEqualsAndHashCodeOnComparableRule

All Implemented Interfaces:

AstVisitor, JavaVisitor, Rule, PropertySource

public class OverrideBothEqualsAndHashCodeOnComparableRule
extends OverrideBothEqualsAndHashcodeRule

Rule that checks Comparable classes for proper equals/hashCode implementations.

This is essentially the same as the rule OverrideBothEqualsAndHashcodeRule but only for Comparable types.

Since:

7.17.0

See Also:

• ComparableImplementedButEqualsNotOverridden

Field Summary

Fields inherited from interface net.sourceforge.pmd.lang.rule.Rule

VIOLATION_SUPPRESS_REGEX_DESCRIPTOR, VIOLATION_SUPPRESS_XPATH_DESCRIPTOR

Constructor Summary

Constructors

Constructor	Description
OverrideBothEqualsAndHashCodeOnComparableRule()

Method Summary

Modifier and Type	Method	Description
protected void	maybeReport(RuleContext ctx, ASTTypeDeclaration node, ASTMethodDeclaration hashCodeMethod, ASTMethodDeclaration equalsMethod)
protected boolean	skipType(ASTTypeDeclaration node)

Methods inherited from class net.sourceforge.pmd.lang.java.rule.errorprone.OverrideBothEqualsAndHashcodeRule

visit, visit, visit

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

buildTargetSelector, visitJavaNode

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

apply, visitNode

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

addExample, asCtx, deepCopy, dysfunctionReason, end, equals, getDescription, getExamples, getExternalInfoUrl, getLanguage, getMaximumLanguageVersion, getMessage, getMinimumLanguageVersion, getName, getPriority, getPropertySourceType, getRuleClass, getRuleSetName, getSince, getTargetSelector, hashCode, isDeprecated, setDeprecated, setDescription, setExternalInfoUrl, setLanguage, setMaximumLanguageVersion, setMessage, setMinimumLanguageVersion, setName, setPriority, setRuleClass, setRuleSetName, setSince, start

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

definePropertyDescriptor, getOverriddenPropertiesByPropertyDescriptor, getOverriddenPropertyDescriptors, getPropertiesByPropertyDescriptor, getProperty, getPropertyDescriptor, getPropertyDescriptors, hasDescriptor, isPropertyOverridden, setProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sourceforge.pmd.lang.ast.AstVisitor

cannotVisit

Methods inherited from interface net.sourceforge.pmd.lang.java.ast.JavaVisitor

visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit

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

definePropertyDescriptor, getOverriddenPropertiesByPropertyDescriptor, getOverriddenPropertyDescriptors, getPropertiesByPropertyDescriptor, getProperty, getPropertyDescriptor, getPropertyDescriptors, hasDescriptor, isPropertyOverridden, setProperty

Methods inherited from interface net.sourceforge.pmd.lang.rule.Rule

initialize

Constructor Details

OverrideBothEqualsAndHashCodeOnComparableRule

public OverrideBothEqualsAndHashCodeOnComparableRule()

Method Details

skipType

protected boolean skipType(ASTTypeDeclaration node)

Overrides:

skipType in class OverrideBothEqualsAndHashcodeRule

maybeReport

protected void maybeReport(RuleContext ctx,
 ASTTypeDeclaration node,
 ASTMethodDeclaration hashCodeMethod,
 ASTMethodDeclaration equalsMethod)

Overrides:

maybeReport in class OverrideBothEqualsAndHashcodeRule