Class FinalLocalVariableCheck

  • All Implemented Interfaces:
    Configurable, Contextualizable

    public class FinalLocalVariableCheck
    extends AbstractCheck

    Ensures that local variables that never get their values changed, must be declared final.

    An example of how to configure the check to validate variable definition is:

     <module name="FinalLocalVariable">
         <property name="tokens" value="VARIABLE_DEF"/>
     </module>
     

    By default, this Check skip final validation on Enhanced For-Loop

    Option 'validateEnhancedForLoopVariable' could be used to make Check to validate even variable from Enhanced For Loop.

    An example of how to configure the check so that it also validates enhanced For Loop Variable is:

     <module name="FinalLocalVariable">
         <property name="tokens" value="VARIABLE_DEF"/>
         <property name="validateEnhancedForLoopVariable" value="true"/>
     </module>
     

    Example:

    for (int number : myNumbers) { // violation System.out.println(number); }

    • 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
    • Constructor Detail

      • FinalLocalVariableCheck

        public FinalLocalVariableCheck()
    • Method Detail

      • setValidateEnhancedForLoopVariable

        public final void setValidateEnhancedForLoopVariable​(boolean validateEnhancedForLoopVariable)
        Whether to check enhanced for-loop variable or not.
        Parameters:
        validateEnhancedForLoopVariable - whether to check for-loop variable
      • 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
      • 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
      • 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
      • leaveToken

        public void leaveToken​(DetailAST ast)
        Description copied from class: AbstractCheck
        Called after all the child nodes have been process.
        Overrides:
        leaveToken in class AbstractCheck
        Parameters:
        ast - the token leaving