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.Check
com.puppycrawl.tools.checkstyle.checks.coding.CovariantEqualsCheck
- All Implemented Interfaces:
- Configurable, Contextualizable
- public class CovariantEqualsCheck
- extends Check
Checks that if a class defines a covariant method equals,
then it defines method equals(java.lang.Object).
Inspired by findbugs,
http://www.cs.umd.edu/~pugh/java/bugs/docs/findbugsPaper.pdf
An example of how to configure the check is:
<module name="CovariantEquals"/>
- Version:
- 1.0
- Author:
- Rick Giles
Methods inherited from class com.puppycrawl.tools.checkstyle.api.Check |
beginTree, destroy, finishTree, getAcceptableTokens, getClassLoader, getFileContents, getLines, 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, log, log, log, setSeverity |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
CovariantEqualsCheck
public CovariantEqualsCheck()
getDefaultTokens
public int[] getDefaultTokens()
- Description copied from class:
Check
- 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 Check
- Returns:
- the default tokens
- See Also:
Check
getRequiredTokens
public int[] getRequiredTokens()
- Description copied from class:
Check
- The tokens that this check must be registered for.
- Overrides:
getRequiredTokens
in class Check
- Returns:
- the token set this must be registered for.
- See Also:
Check
visitToken
public void visitToken(DetailAST aAST)
- Description copied from class:
Check
- Called to process a token.
- Overrides:
visitToken
in class Check
- Parameters:
aAST
- the token to process- See Also:
Check