From c15ece60e2e9ff87fa9a52064c108fe4ee1923d0 Mon Sep 17 00:00:00 2001
From: Kristian Scheibe <k.scheibe@posteo.de>
Date: Sat, 8 Dec 2018 16:18:50 +0100
Subject: [PATCH] LocalVariableCouldBeFinal: Added property to allow ignoring
 variables declared in a for-each statement.

---
 .../src/main/resources/category/java/codestyle.xml |  3 +++
 .../codestyle/xml/LocalVariableCouldBeFinal.xml    | 14 ++++++++++++++
 2 files changed, 17 insertions(+)

diff --git a/pmd-java/src/main/resources/category/java/codestyle.xml b/pmd-java/src/main/resources/category/java/codestyle.xml
index b5ded22baf..32af525984 100644
--- a/pmd-java/src/main/resources/category/java/codestyle.xml
+++ b/pmd-java/src/main/resources/category/java/codestyle.xml
@@ -1127,6 +1127,9 @@ public interface MissingProperSuffix extends javax.ejb.EJBLocalObject {}    // n
 A local variable assigned only once can be declared final.
         </description>
         <priority>3</priority>
+        <properties>
+            <property name="ignoreForEachDecl" type="Boolean" description="Ignore non-final loop variables in a for-each statement." value="false"/>
+        </properties>
         <example>
 <![CDATA[
 public class Bar {
diff --git a/pmd-java/src/test/resources/net/sourceforge/pmd/lang/java/rule/codestyle/xml/LocalVariableCouldBeFinal.xml b/pmd-java/src/test/resources/net/sourceforge/pmd/lang/java/rule/codestyle/xml/LocalVariableCouldBeFinal.xml
index 37db064a4b..29198eb00f 100644
--- a/pmd-java/src/test/resources/net/sourceforge/pmd/lang/java/rule/codestyle/xml/LocalVariableCouldBeFinal.xml
+++ b/pmd-java/src/test/resources/net/sourceforge/pmd/lang/java/rule/codestyle/xml/LocalVariableCouldBeFinal.xml
@@ -175,4 +175,18 @@ public class Test {
 }
        ]]></code>
    </test-code>
+    <test-code>
+        <description>Parameter to ignore non-final variables in for each loops (see #1513).</description>
+        <rule-property name="ignoreForEachDecl">true</rule-property>
+        <expected-problems>0</expected-problems>
+        <code><![CDATA[
+public class Foo {
+ public void bar() {
+  for ( String c : strings ) {
+   System.out.println(c); // use c
+  }
+ }
+}
+        ]]></code>
+    </test-code>
 </test-data>