Issue checkstyle#16081: FinalLocalVariable should check interface par…

…ameters
Machine-Maker · Jan 18, 2025 · 12fc12c · 12fc12c
1 parent 8fedfc2
commit 12fc12c
Show file tree

Hide file tree

Showing 4 changed files with 37 additions and 3 deletions.
diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/FinalLocalVariableCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/FinalLocalVariableCheck.java
@@ -240,7 +240,8 @@ public void visitToken(DetailAST ast) {
                         && ast.findFirstToken(TokenTypes.MODIFIERS)
                             .findFirstToken(TokenTypes.FINAL) == null
                         && !isInAbstractOrNativeMethod(ast)
-                        && !ScopeUtil.isInInterfaceBlock(ast)
+                        && (!ScopeUtil.isInInterfaceBlock(ast)
+                                || ScopeUtil.isStaticDefaultOrPrivateMethod(ast))
                         && !isMultipleTypeCatch(ast)
                         && !CheckUtil.isReceiverParameter(ast)) {
                     insertParameter(ast);

diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/utils/ScopeUtil.java b/src/main/java/com/puppycrawl/tools/checkstyle/utils/ScopeUtil.java
@@ -363,4 +363,25 @@ public static boolean isInScope(DetailAST ast, Scope scope) {
         return surroundingScopeOfAstToken == scope;
     }
 
+    /**
+     * Check if given parameter definition is for a static, default or private method.
+     *
+     * @param parameterDefAst parameter definition
+     * @return true if it is for a static, default or private method, false otherwise
+     */
+    public static boolean isStaticDefaultOrPrivateMethod(DetailAST parameterDefAst) {
+        boolean staticDefaultOrPrivate = false;
+        DetailAST currentAst = parameterDefAst;
+        while (currentAst != null && !staticDefaultOrPrivate) {
+            if (currentAst.getType() == TokenTypes.METHOD_DEF) {
+                final DetailAST modifiers =
+                    currentAst.findFirstToken(TokenTypes.MODIFIERS);
+                staticDefaultOrPrivate = modifiers.findFirstToken(TokenTypes.LITERAL_STATIC) != null
+                    || modifiers.findFirstToken(TokenTypes.LITERAL_DEFAULT) != null
+                    || modifiers.findFirstToken(TokenTypes.LITERAL_PRIVATE) != null;
+            }
+            currentAst = currentAst.getParent();
+        }
+        return staticDefaultOrPrivate;
+    }
 }
diff --git a/src/test/java/com/puppycrawl/tools/checkstyle/checks/coding/FinalLocalVariableCheckTest.java b/src/test/java/com/puppycrawl/tools/checkstyle/checks/coding/FinalLocalVariableCheckTest.java
@@ -139,8 +139,11 @@ public void testInputFinalLocalVariable2One() throws Exception {
     public void testInputFinalLocalVariable2Two() throws Exception {
 
         final String[] excepted = {
-            "78:36: " + getCheckMessage(MSG_KEY, "_o"),
-            "83:37: " + getCheckMessage(MSG_KEY, "_o1"),
+            "53:36: " + getCheckMessage(MSG_KEY, "bParam"),
+            "56:34: " + getCheckMessage(MSG_KEY, "cParam"),
+            "59:36: " + getCheckMessage(MSG_KEY, "dParam"),
+            "87:36: " + getCheckMessage(MSG_KEY, "_o"),
+            "92:37: " + getCheckMessage(MSG_KEY, "_o1"),
         };
         verifyWithInlineConfigParser(
                 getPath("InputFinalLocalVariable2Two.java"), excepted);

diff --git a/...ycrawl/tools/checkstyle/checks/coding/finallocalvariable/InputFinalLocalVariable2Two.java b/...ycrawl/tools/checkstyle/checks/coding/finallocalvariable/InputFinalLocalVariable2Two.java
@@ -49,6 +49,15 @@ class InnerClass
 interface Inter2
 {
     void method(int aParam);
+
+    default void defaultMethod(int bParam) { // violation
+    }
+
+    static void staticMethod(int cParam) { // violation
+    }
+
+    private void privateMethod(int dParam) { // violation
+    }
 }
 
 abstract class AbstractClass2