Class FinalLocalVariableCheck

Checks that local variables that never have their values changed are declared final. The check can be configured to also check that unchanged parameters are declared final.

When configured to check parameters, the check ignores parameters of interface methods and abstract methods.

• Property validateEnhancedForLoopVariable - Control whether to check enhanced for-loop variable. Type is boolean. Default value is false.
• Property tokens - tokens to check Type is java.lang.String[]. Validation type is tokenSet. Default value is: VARIABLE_DEF.

To configure the check:

 <module name="FinalLocalVariable"/>
 

To configure the check so that it checks local variables and parameters:

 <module name="FinalLocalVariable">
   <property name="tokens" value="VARIABLE_DEF,PARAMETER_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);
 }
 

An example of how to configure check on local variables and parameters but do not validate loop variables:

 <module name="FinalLocalVariable">
    <property name="tokens" value="VARIABLE_DEF,PARAMETER_DEF"/>
    <property name="validateEnhancedForLoopVariable" value="false"/>
  </module>
 

Example:

 public class MyClass {
   static int foo(int x, int y) { //violations, parameters should be final
     return x+y;
   }
   public static void main (String []args) { //violation, parameters should be final
     for (String i : args) {
       System.out.println(i);
     }
     int result=foo(1,2); // violation
   }
 }
 

Parent is com.puppycrawl.tools.checkstyle.TreeWalker

Violation Message Keys:

• final.variable