Java: exclude overloads of finalize

Jami Cogswell · Jami Cogswell · commit ed22a16f32df · 2025-03-27T19:35:46.000-04:00
diff --git a/java/ql/src/Violations of Best Practice/Undesirable Calls/DoNotCallFinalize.md b/java/ql/src/Violations of Best Practice/Undesirable Calls/DoNotCallFinalize.md
@@ -1,10 +1,10 @@
 ## Overview
 
-Calling `finalize` in application code may cause inconsistent program state or unpredicatable behavior.
+Calling `finalize()` in application code may cause inconsistent program state or unpredicatable behavior.
 
 ## Recommendation
 
-Avoid calling `finalize` in application code. Allow the JVM to determine a garbage collection schedule instead.
+Avoid calling `finalize()` in application code. Allow the JVM to determine a garbage collection schedule instead.
 
 ## Example
 
@@ -19,7 +19,7 @@ public class Test {
 
 # Implementation Notes
 
-This rule is focused on the use of existing `finalize` invocations rather than attempts to write a custom implementation.
+This rule is focused on the use of existing `finalize()` invocations rather than attempts to write a custom implementation.
 
 ## References
 
diff --git a/java/ql/src/Violations of Best Practice/Undesirable Calls/DoNotCallFinalize.ql b/java/ql/src/Violations of Best Practice/Undesirable Calls/DoNotCallFinalize.ql
@@ -1,8 +1,8 @@
 /**
  * @id java/do-not-call-finalize
  * @previous-id java/do-not-use-finalizers
- * @name Do not call `finalize`
- * @description Calling `finalize` in application code may cause
+ * @name Do not call `finalize()`
+ * @description Calling `finalize()` in application code may cause
  *              inconsistent program state or unpredicatable behavior.
  * @kind problem
  * @precision high
@@ -16,13 +16,13 @@ import java
 
 from MethodCall mc
 where
-  mc.getMethod().hasName("finalize") and
-  // The Java documentation for `finalize` states: "If a subclass overrides
+  mc.getMethod() instanceof FinalizeMethod and
+  // The Java documentation for `finalize()` states: "If a subclass overrides
   // `finalize` it must invoke the superclass finalizer explicitly". Therefore,
-  // we do not alert on `super.finalize` calls that occur within a callable
+  // we do not alert on `super.finalize()` calls that occur within a callable
   // that overrides `finalize`.
   not exists(Callable caller, FinalizeMethod fm | caller = mc.getCaller() |
     caller.(Method).overrides(fm) and
     mc.getQualifier() instanceof SuperAccess
   )
-select mc, "Call to 'finalize'."
+select mc, "Call to 'finalize()'."
diff --git a/java/ql/src/change-notes/2025-03-20-do-not-call-finalize.md b/java/ql/src/change-notes/2025-03-20-do-not-call-finalize.md
@@ -1,4 +1,4 @@
 ---
 category: newQuery
 ---
-* Added a new quality query, `java/do-not-call-finalize`, to detect calls to `finalize`.
+* Added a new quality query, `java/do-not-call-finalize`, to detect calls to `finalize()`.
diff --git a/java/ql/test/query-tests/DoNotCallFinalize/DoNotCallFinalize.expected b/java/ql/test/query-tests/DoNotCallFinalize/DoNotCallFinalize.expected
@@ -1,2 +1 @@
-| Test.java:4:9:4:23 | finalize(...) | Call to 'finalize'. |
-| Test.java:25:9:25:33 | finalize(...) | Call to 'finalize'. |
+| Test.java:4:9:4:23 | finalize(...) | Call to 'finalize()'. |
diff --git a/java/ql/test/query-tests/DoNotCallFinalize/Test.java b/java/ql/test/query-tests/DoNotCallFinalize/Test.java
@@ -10,7 +10,7 @@ void f1() throws Throwable {
 
     @Override
     protected void finalize() throws Throwable {
-        // COMPLIANT: If a subclass overrides `finalize`
+        // COMPLIANT: If a subclass overrides `finalize()`
         // it must invoke the superclass finalizer explicitly.
         super.finalize();
     }
@@ -20,9 +20,9 @@ protected void finalize(String s) throws Throwable {
         System.out.println(s);
     }
 
-    // NON_COMPLIANT: call to overload of `finalize`
+    // COMPLIANT: call to overload of `finalize`
     void f2() throws Throwable {
-        this.finalize("overload"); // $ Alert
+        this.finalize("overload");
     }
 
 }

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1 @@`
`1`		`-\| Test.java:4:9:4:23 \| finalize(...) \| Call to 'finalize'. \|`
`2`		`-\| Test.java:25:9:25:33 \| finalize(...) \| Call to 'finalize'. \|`
	`1`	`+\| Test.java:4:9:4:23 \| finalize(...) \| Call to 'finalize()'. \|`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ void f1() throws Throwable {`
`10`	`10`
`11`	`11`	`@Override`
`12`	`12`	`protected void finalize() throws Throwable {`
`13`		- // COMPLIANT: If a subclass overrides `finalize`
	`13`	+ // COMPLIANT: If a subclass overrides `finalize()`
`14`	`14`	`// it must invoke the superclass finalizer explicitly.`
`15`	`15`	`super.finalize();`
`16`	`16`	`}`
`@@ -20,9 +20,9 @@ protected void finalize(String s) throws Throwable {`
`20`	`20`	`System.out.println(s);`
`21`	`21`	`}`
`22`	`22`
`23`		- // NON_COMPLIANT: call to overload of `finalize`
	`23`	+ // COMPLIANT: call to overload of `finalize`
`24`	`24`	`void f2() throws Throwable {`
`25`		`- this.finalize("overload"); // $ Alert`
	`25`	`+ this.finalize("overload");`
`26`	`26`	`}`
`27`	`27`
`28`	`28`	`}`