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

Class LocalVariableNameCheck

  • All Implemented Interfaces:
    Configurable, Contextualizable
    public class LocalVariableNameCheck
extends AbstractNameCheck
    Checks that local, non-final variable names conform to a specified pattern. A catch parameter is considered to be a local variable.

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

    • Property allowOneCharVarInForLoop - Allow one character variable name in initialization expressions in FOR loop if one char variable name is prohibited by format regexp. Type is boolean. Default value is false.
    • Property format - Sets the pattern to match valid identifiers. Type is java.util.regex.Pattern. Default value is "^([a-z][a-zA-Z0-9]*|_)$".

    Parent is com.puppycrawl.tools.checkstyle.TreeWalker

    Violation Message Keys:

    • name.invalidPattern
    Since:
    3.0

    • Constructor Detail

    • Method Detail

      • setAllowOneCharVarInForLoop

        public final void setAllowOneCharVarInForLoop​(boolean allow)
        Setter to allow one character variable name in initialization expressions in FOR loop if one char variable name is prohibited by format regexp.
        Parameters:
        allow - Flag for allowing or not one character name in FOR loop.
        Since:
        5.8

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

      • isForLoopVariable

        private static boolean isForLoopVariable​(DetailAST variableDef)
        Checks if a variable is the loop's one.
        Parameters:
        variableDef - variable definition.
        Returns:
        true if a variable is the loop's one.