Class LocalVariableNameCheck

  • All Implemented Interfaces:
    Configurable, Contextualizable

    public class LocalVariableNameCheck
    extends AbstractNameCheck

    Checks that local, non-final variable names conform to a format specified by the format property. A catch parameter is considered to be a local variable. The format is a regular expression and defaults to ^[a-z][a-zA-Z0-9]*$.

    An example of how to configure the check is:

     <module name="LocalVariableName"/>
     

    An example of how to configure the check for names that begin with a lower case letter, followed by letters, digits, and underscores is:

     <module name="LocalVariableName">
        <property name="format" value="^[a-z](_?[a-zA-Z0-9]+)*$"/>
     </module>
     

    An example of one character variable name in initialization expression(like "i") in FOR loop:

     for(int i = 1; i < 10; i++) {}
     

    An example of how to configure the check to allow one char variable name in initialization expressions in FOR loop:

     <module name="LocalVariableName">
        <property name="allowOneCharVarInForLoop" value="true"/>
     </module>
     
    Author:
    Rick Giles, maxvetrenko
    • Constructor Detail

    • Method Detail

      • setAllowOneCharVarInForLoop

        public final void setAllowOneCharVarInForLoop​(boolean allow)
        Sets whether to allow one character name in FOR loop or not.
        Parameters:
        allow - Flag for allowing or not one character name in FOR loop.
      • 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.