Package com.puppycrawl.tools.checkstyle.checks.coding

Class 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 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

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