com.puppycrawl.tools.checkstyle.checks.coding

Class CovariantEqualsCheck

java.lang.Object

com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

com.puppycrawl.tools.checkstyle.api.AbstractCheck

com.puppycrawl.tools.checkstyle.checks.coding.CovariantEqualsCheck

All Implemented Interfaces:

Configurable, Contextualizable

public class CovariantEqualsCheck
extends AbstractCheck

Checks that if a class defines a covariant method equals, then it defines method equals(java.lang.Object). Inspired by findbugs, http://findbugs.sourceforge.net/bugDescriptions.html#EQ_SELF_NO_OBJECT

An example of how to configure the check is:

 <module name="CovariantEquals"/>
 

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Set<DetailAST>	equalsMethods Set of equals method definitions.
static java.lang.String	MSG_KEY A key is pointing to the warning message text in "messages.properties" file.

Constructor Summary

Constructors

Constructor and Description
CovariantEqualsCheck()

Method Summary

Modifier and Type	Method and Description
int[]	getAcceptableTokens() The configurable token set.
int[]	getDefaultTokens() Returns the default token a check is interested in.
int[]	getRequiredTokens() The tokens that this check must be registered for.
private static boolean	isFirstParameterObject(DetailAST methodDefAst) Tests whether a method's first parameter is an Object.
void	visitToken(DetailAST ast) Called to process a token.

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

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

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

getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, 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

MSG_KEY

public static final java.lang.String MSG_KEY

A key is pointing to the warning message text in "messages.properties" file.

See Also:

Constant Field Values

equalsMethods

private final java.util.Set<DetailAST> equalsMethods

Set of equals method definitions.

Constructor Detail

CovariantEqualsCheck

public CovariantEqualsCheck()

Method Detail

getDefaultTokens

public int[] getDefaultTokens()

Description copied from class: AbstractCheck

Returns the default token a check is interested in. Only used if the configuration for a check does not define the tokens.

Specified by:

getDefaultTokens in class AbstractCheck

Returns:

the default tokens

See Also:

TokenTypes

getRequiredTokens

public int[] getRequiredTokens()

Description copied from class: AbstractCheck

The tokens that this check must be registered for.

Specified by:

getRequiredTokens in class AbstractCheck

Returns:

the token set this must be registered for.

See Also:

TokenTypes

getAcceptableTokens

public int[] getAcceptableTokens()

Description copied from class: AbstractCheck

The configurable token set. Used to protect Checks against malicious users who specify an unacceptable token set in the configuration file. The default implementation returns the check's default tokens.

Specified by:

getAcceptableTokens in class AbstractCheck

Returns:

the token set this check is designed for.

See Also:

TokenTypes

visitToken

public void visitToken(DetailAST ast)

Description copied from class: AbstractCheck

Called to process a token.

Overrides:

visitToken in class AbstractCheck

Parameters:

ast - the token to process

isFirstParameterObject

private static boolean isFirstParameterObject(DetailAST methodDefAst)

Tests whether a method's first parameter is an Object.

Parameters:

methodDefAst - the method definition AST to test. Precondition: ast is a TokenTypes.METHOD_DEF node.

Returns:

true if ast has first parameter of type Object.