Package com.puppycrawl.tools.checkstyle.checks.naming

Class LocalFinalVariableNameCheck

  • All Implemented Interfaces:
    Configurable, Contextualizable
    public class LocalFinalVariableNameCheck
extends AbstractNameCheck
    Checks that local final variable names conform to a specified pattern. A catch parameter and resources in try statements are considered to be a local, final variables.

    This check does not support final pattern variables. Instead, use PatternVariableName.

    • Property format - Sets the pattern to match valid identifiers. Type is java.util.regex.Pattern. Default value is "^([a-z][a-zA-Z0-9]*|_)$".
    • Property tokens - tokens to check Type is java.lang.String[]. Validation type is tokenSet. Default value is: VARIABLE_DEF, PARAMETER_DEF, RESOURCE.

    Parent is com.puppycrawl.tools.checkstyle.TreeWalker

    Violation Message Keys:

    • name.invalidPattern
    Since:
    3.0

    • Method Detail

      • 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

      • mustCheckName

        protected final boolean mustCheckName​(DetailAST ast)
        Description copied from class: AbstractNameCheck
        Decides whether the name of an AST should be checked against the format regexp.
        Specified by:
        mustCheckName in class AbstractNameCheck
        Parameters:
        ast - the AST to check.
        Returns:
        true if the IDENT subnode of ast should be checked against the format regexp.