EqualsHashCodeCheck

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> com >> puppycrawl >> tools >> checkstyle >> [ checks overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of com.puppycrawl.tools.checkstyle.checks.EqualsHashCodeCheck

SOURCE |

Download com.puppycrawl.tools.checkstyle.checks.EqualsHashCodeCheck

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.puppycrawl.tools.checkstyle.checks
Class EqualsHashCodeCheck

java.lang.Object
  com.puppycrawl.tools.checkstyle.api.AutomaticBean
      com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
          com.puppycrawl.tools.checkstyle.api.Check
              com.puppycrawl.tools.checkstyle.checks.EqualsHashCodeCheck

All Implemented Interfaces:: com.puppycrawl.tools.checkstyle.api.Configurable, com.puppycrawl.tools.checkstyle.api.Contextualizable

public class EqualsHashCodeCheck
extends com.puppycrawl.tools.checkstyle.api.Check

Checks that classes that override equals() also override hashCode().

Rationale: The contract of equals() and hashCode() requires that equal objects have the same hashCode. Hence, whenever you override equals() you must override hashCode() to ensure that your class can be used in collections that are hash based.

An example of how to configure the check is:

 <module name="EqualsHashCode"/>

Field Summary

private java.util.Map mObjBlockEquals
          maps OBJ_BLOCK to the method definition of equals()

private java.util.Set mObjBlockWithHashCode
          the set of OBJ_BLOCKs that contain a definition of hashCode()

Fields inherited from class com.puppycrawl.tools.checkstyle.api.Check

Fields inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

Fields inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

Constructor Summary

EqualsHashCodeCheck()


Method Summary

void beginTree()


void finishTree()


int[] getDefaultTokens()
          Returns the default token a check is interested in.

private boolean isObjectParam(antlr.collections.AST aFirstChild)
          Determines if an AST is a formal param of type Object (or subclass).

void visitToken(com.puppycrawl.tools.checkstyle.api.DetailAST aAST)
          Called to process a token.

Methods inherited from class com.puppycrawl.tools.checkstyle.api.Check

beginTree, destroy, finishTree, getAcceptableTokens, getClassLoader, getFileContents, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

getMessageBundle, getSeverity, getSeverityLevel, log, log, log, log, log, log, setSeverity

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

configure, contextualize, finishLocalSetup, getConfiguration, setupChild

Methods inherited from class java.lang.Object

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

Field Detail

mObjBlockEquals

private final java.util.Map mObjBlockEquals

maps OBJ_BLOCK to the method definition of equals()

mObjBlockWithHashCode

private final java.util.Set mObjBlockWithHashCode

the set of OBJ_BLOCKs that contain a definition of hashCode()

Constructor Detail