com.puppycrawl.tools.checkstyle.meta.checks.coding.FinalLocalVariableCheck.xml Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of checkstyle Show documentation

Checkstyle is a development tool to help programmers write Java code that adheres to a coding standard

There is a newer version: 8.8

<?xml version="1.0" encoding="UTF-8"?>
<checkstyle-metadata>
   <module>
      <check fully-qualified-name="com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck"
             name="FinalLocalVariable"
             parent="com.puppycrawl.tools.checkstyle.TreeWalker">
         <description>&lt;div&gt;
 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.
 &lt;/div&gt;

 &lt;p&gt;
 When configured to check parameters, the check ignores parameters of interface
 methods and abstract methods.
 &lt;/p&gt;</description>
         <properties>
            <property default-value="false"
                      name="validateEnhancedForLoopVariable"
                      type="boolean">
               <description>Control whether to check
 &lt;a href="https://docs.oracle.com/javase/specs/jls/se11/html/jls-14.html#jls-14.14.2"&gt;
 enhanced for-loop&lt;/a&gt; variable.</description>
            </property>
            <property default-value="false"
                      name="validateUnnamedVariables"
                      type="boolean">
               <description>Control whether to check
 &lt;a href="https://docs.oracle.com/javase/specs/jls/se21/preview/specs/unnamed-jls.html"&gt;
 unnamed variables&lt;/a&gt;.</description>
            </property>
            <property default-value="VARIABLE_DEF"
                      name="tokens"
                      type="java.lang.String[]"
                      validation-type="tokenSet">
               <description>tokens to check</description>
            </property>
         </properties>
         <message-keys>
            <message-key key="final.variable"/>
         </message-keys>
      </check>
   </module>
</checkstyle-metadata>