GROOVY-11911: Deprecate callsite versions of BooleanClosureWrapper

paulk-asert · paulk-asert · commit bc8bc7aa451f · 2026-04-08T19:43:09.000+10:00
diff --git a/src/main/java/groovy/lang/Closure.java b/src/main/java/groovy/lang/Closure.java
@@ -28,7 +28,7 @@
 import org.codehaus.groovy.runtime.GeneratedClosure;
 import org.codehaus.groovy.runtime.InvokerHelper;
 import org.codehaus.groovy.runtime.InvokerInvocationException;
-import org.codehaus.groovy.runtime.callsite.BooleanClosureWrapper;
+import org.codehaus.groovy.runtime.BooleanClosureWrapper;
 import org.codehaus.groovy.runtime.memoize.ConcurrentCommonCache;
 import org.codehaus.groovy.runtime.memoize.ConcurrentSoftCache;
 import org.codehaus.groovy.runtime.memoize.LRUCache;
diff --git a/src/main/java/org/codehaus/groovy/runtime/ArrayGroovyMethods.java b/src/main/java/org/codehaus/groovy/runtime/ArrayGroovyMethods.java
@@ -38,10 +38,10 @@
 import groovy.util.function.IntComparator;
 import groovy.util.function.LongComparator;
 import org.apache.groovy.lang.annotation.Incubating;
-import org.codehaus.groovy.runtime.callsite.BooleanClosureWrapper;
-import org.codehaus.groovy.runtime.callsite.BooleanReturningMethodInvoker;
-import org.codehaus.groovy.runtime.dgmimpl.NumberNumberDiv;
+import org.codehaus.groovy.runtime.BooleanClosureWrapper;
 import org.codehaus.groovy.runtime.typehandling.DefaultTypeTransformation;
+import org.codehaus.groovy.runtime.InvokerHelper;
+import org.codehaus.groovy.runtime.dgmimpl.NumberNumberDiv;
 import org.codehaus.groovy.util.ArrayIterable;
 import org.codehaus.groovy.util.ArrayIterator;
 import org.codehaus.groovy.util.BooleanArrayIterator;
@@ -4319,9 +4319,8 @@ public static <T> List<T> grep(T[] self) {
      */
     public static <T> List<T> grep(T[] self, Object filter) {
         List<T> answer = new ArrayList<>();
-        BooleanReturningMethodInvoker bmi = new BooleanReturningMethodInvoker("isCase");
         for (T element : self) {
-            if (bmi.invoke(filter, element)) {
+            if (DefaultTypeTransformation.castToBoolean(InvokerHelper.invokeMethod(filter, "isCase", element))) {
                 answer.add(element);
             }
         }
diff --git a/src/main/java/org/codehaus/groovy/runtime/BooleanClosureForMapPredicate.java b/src/main/java/org/codehaus/groovy/runtime/BooleanClosureForMapPredicate.java
@@ -0,0 +1,50 @@
+/*
+ *  Licensed to the Apache Software Foundation (ASF) under one
+ *  or more contributor license agreements.  See the NOTICE file
+ *  distributed with this work for additional information
+ *  regarding copyright ownership.  The ASF licenses this file
+ *  to you under the Apache License, Version 2.0 (the
+ *  "License"); you may not use this file except in compliance
+ *  with the License.  You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing,
+ *  software distributed under the License is distributed on an
+ *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ *  KIND, either express or implied.  See the License for the
+ *  specific language governing permissions and limitations
+ *  under the License.
+ */
+package org.codehaus.groovy.runtime;
+
+import groovy.lang.Closure;
+
+import java.util.Map;
+import java.util.function.Predicate;
+
+/**
+ * Adapts a {@link Closure} to a {@link Predicate} over {@link Map.Entry} values.
+ * If the closure takes two parameters, the key and value are passed separately;
+ * otherwise the {@link Map.Entry} itself is passed.
+ *
+ * @since 6.0.0
+ */
+public class BooleanClosureForMapPredicate<K, V> implements Predicate<Map.Entry<K, V>> {
+    private final BooleanClosureWrapper bcw;
+    private final int numberOfArguments;
+
+    public BooleanClosureForMapPredicate(Closure wrapped) {
+        this.bcw = new BooleanClosureWrapper(wrapped);
+        this.numberOfArguments = wrapped.getMaximumNumberOfParameters();
+    }
+
+    @Override
+    public boolean test(Map.Entry<K, V> entry) {
+        if (numberOfArguments == 2) {
+            return bcw.call(entry.getKey(), entry.getValue());
+        } else {
+            return bcw.call(entry);
+        }
+    }
+}
diff --git a/src/main/java/org/codehaus/groovy/runtime/BooleanClosurePredicate.java b/src/main/java/org/codehaus/groovy/runtime/BooleanClosurePredicate.java
@@ -16,10 +16,27 @@
  *  specific language governing permissions and limitations
  *  under the License.
  */
-package org.codehaus.groovy.runtime.callsite;
+package org.codehaus.groovy.runtime;
 
-public class DummyCallSite extends AbstractCallSite {
-    public DummyCallSite(CallSiteArray array, int index, String name) {
-        super(array, index,name);
+import groovy.lang.Closure;
+
+import java.util.function.Predicate;
+
+/**
+ * Adapts a {@link Closure} to a {@link Predicate}, converting the closure's
+ * return value to a boolean using Groovy truth semantics.
+ *
+ * @since 6.0.0
+ */
+public class BooleanClosurePredicate<T> implements Predicate<T> {
+    private final BooleanClosureWrapper bcw;
+
+    public BooleanClosurePredicate(Closure wrapped) {
+        this.bcw = new BooleanClosureWrapper(wrapped);
+    }
+
+    @Override
+    public boolean test(T arg) {
+        return bcw.call(arg);
     }
 }
diff --git a/src/main/java/org/codehaus/groovy/runtime/BooleanClosureWrapper.java b/src/main/java/org/codehaus/groovy/runtime/BooleanClosureWrapper.java
@@ -0,0 +1,65 @@
+/*
+ *  Licensed to the Apache Software Foundation (ASF) under one
+ *  or more contributor license agreements.  See the NOTICE file
+ *  distributed with this work for additional information
+ *  regarding copyright ownership.  The ASF licenses this file
+ *  to you under the Apache License, Version 2.0 (the
+ *  "License"); you may not use this file except in compliance
+ *  with the License.  You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing,
+ *  software distributed under the License is distributed on an
+ *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ *  KIND, either express or implied.  See the License for the
+ *  specific language governing permissions and limitations
+ *  under the License.
+ */
+package org.codehaus.groovy.runtime;
+
+import groovy.lang.Closure;
+import org.codehaus.groovy.runtime.typehandling.DefaultTypeTransformation;
+
+import java.util.Map;
+
+/**
+ * Helper class for internal use only. This allows calling a {@link Closure} and
+ * converting the result to a boolean using Groovy truth semantics:
+ * null returns false, Boolean is unboxed, and for other types
+ * {@code asBoolean()} is called.
+ *
+ * @since 6.0.0
+ */
+public class BooleanClosureWrapper {
+    private final Closure wrapped;
+    private final int numberOfArguments;
+
+    public BooleanClosureWrapper(Closure wrapped) {
+        this.wrapped = wrapped;
+        this.numberOfArguments = wrapped.getMaximumNumberOfParameters();
+    }
+
+    /**
+     * Normal closure call with boolean conversion.
+     */
+    public boolean call(Object... args) {
+        Object result = wrapped.call(args);
+        if (result == null) return false;
+        if (result instanceof Boolean) return (Boolean) result;
+        return DefaultTypeTransformation.castToBoolean(result);
+    }
+
+    /**
+     * Bridge for a call based on a map entry. If the call is done on a {@link Closure}
+     * taking one argument, then we give in the {@link Map.Entry}, otherwise we will
+     * give in the key and value.
+     */
+    public <K, V> boolean callForMap(Map.Entry<K, V> entry) {
+        if (numberOfArguments == 2) {
+            return call(entry.getKey(), entry.getValue());
+        } else {
+            return call(entry);
+        }
+    }
+}
diff --git a/src/main/java/org/codehaus/groovy/runtime/DefaultGroovyMethods.java b/src/main/java/org/codehaus/groovy/runtime/DefaultGroovyMethods.java
@@ -63,10 +63,9 @@
 import org.codehaus.groovy.reflection.MixinInMetaClass;
 import org.codehaus.groovy.reflection.ReflectionUtils;
 import org.codehaus.groovy.reflection.stdclasses.CachedSAMClass;
-import org.codehaus.groovy.runtime.callsite.BooleanClosureForMapPredicate;
-import org.codehaus.groovy.runtime.callsite.BooleanClosurePredicate;
-import org.codehaus.groovy.runtime.callsite.BooleanClosureWrapper;
-import org.codehaus.groovy.runtime.callsite.BooleanReturningMethodInvoker;
+import org.codehaus.groovy.runtime.BooleanClosureForMapPredicate;
+import org.codehaus.groovy.runtime.BooleanClosurePredicate;
+import org.codehaus.groovy.runtime.BooleanClosureWrapper;
 import org.codehaus.groovy.runtime.dgmimpl.NumberNumberDiv;
 import org.codehaus.groovy.runtime.dgmimpl.NumberNumberMinus;
 import org.codehaus.groovy.runtime.dgmimpl.NumberNumberMultiply;
@@ -574,9 +573,8 @@ public static <T> SortedSet<T> and(SortedSet<T> left, Iterable<T> right, Compara
      * @since 1.5.0
      */
     public static boolean any(Object self) {
-        BooleanReturningMethodInvoker bmi = new BooleanReturningMethodInvoker();
         for (var iter = InvokerHelper.asIterator(self); iter.hasNext(); ) {
-            if (bmi.convertToBoolean(iter.next())) {
+            if (DefaultTypeTransformation.castToBoolean(iter.next())) {
                 return true;
             }
         }
@@ -5301,9 +5299,8 @@ public static <K, V> boolean every(Map<K, V> self, @ClosureParams(value = MapEnt
      * @since 1.5.0
      */
     public static boolean every(Object self) {
-        BooleanReturningMethodInvoker bmi = new BooleanReturningMethodInvoker();
         for (Iterator iter = InvokerHelper.asIterator(self); iter.hasNext(); ) {
-            if (!bmi.convertToBoolean(iter.next())) {
+            if (!DefaultTypeTransformation.castToBoolean(iter.next())) {
                 return false;
             }
         }
@@ -7578,10 +7575,9 @@ private static boolean isRootLoaderClassOrSubClass(ClassLoader self) {
     @SuppressWarnings("unchecked")
     public static Collection grep(Object self, Object filter) {
         Collection answer = createSimilarOrDefaultCollection(self);
-        BooleanReturningMethodInvoker bmi = new BooleanReturningMethodInvoker("isCase");
         for (Iterator iter = InvokerHelper.asIterator(self); iter.hasNext();) {
             Object object = iter.next();
-            if (bmi.invoke(filter, object)) {
+            if (DefaultTypeTransformation.castToBoolean(InvokerHelper.invokeMethod(filter, "isCase", object))) {
                 answer.add(object);
             }
         }
@@ -7609,9 +7605,8 @@ public static Collection grep(Object self, Object filter) {
      */
     public static <T> Collection<T> grep(Collection<T> self, Object filter) {
         Collection<T> answer = createSimilarCollection(self);
-        BooleanReturningMethodInvoker bmi = new BooleanReturningMethodInvoker("isCase");
         for (T element : self) {
-            if (bmi.invoke(filter, element)) {
+            if (DefaultTypeTransformation.castToBoolean(InvokerHelper.invokeMethod(filter, "isCase", element))) {
                 answer.add(element);
             }
         }
diff --git a/src/main/java/org/codehaus/groovy/runtime/IOGroovyMethods.java b/src/main/java/org/codehaus/groovy/runtime/IOGroovyMethods.java
@@ -28,7 +28,7 @@
 import groovy.transform.stc.PickFirstResolver;
 import groovy.transform.stc.SimpleType;
 import org.apache.groovy.io.StringBuilderWriter;
-import org.codehaus.groovy.runtime.callsite.BooleanClosureWrapper;
+import org.codehaus.groovy.runtime.BooleanClosureWrapper;
 
 import java.io.BufferedReader;
 import java.io.BufferedWriter;
diff --git a/src/main/java/org/codehaus/groovy/runtime/ResourceGroovyMethods.java b/src/main/java/org/codehaus/groovy/runtime/ResourceGroovyMethods.java
@@ -31,7 +31,6 @@
 import groovy.transform.stc.PickFirstResolver;
 import groovy.transform.stc.SimpleType;
 import groovy.util.CharsetToolkit;
-import org.codehaus.groovy.runtime.callsite.BooleanReturningMethodInvoker;
 import org.codehaus.groovy.runtime.typehandling.DefaultTypeTransformation;
 
 import java.io.BufferedInputStream;
@@ -1651,12 +1650,11 @@ public static void eachFileMatch(final File self, final FileType fileType, final
         final File[] files = self.listFiles();
         // null check because of http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4803836
         if (files == null) return;
-        BooleanReturningMethodInvoker bmi = new BooleanReturningMethodInvoker("isCase");
         for (final File currentFile : files) {
             if (fileType == FileType.ANY ||
                     (fileType != FileType.FILES && currentFile.isDirectory()) ||
                     (fileType != FileType.DIRECTORIES && currentFile.isFile())) {
-                if (bmi.invoke(nameFilter, currentFile.getName()))
+                if (DefaultTypeTransformation.castToBoolean(InvokerHelper.invokeMethod(nameFilter, "isCase", currentFile.getName())))
                     closure.call(currentFile);
             }
         }
diff --git a/src/main/java/org/codehaus/groovy/runtime/callsite/BooleanClosureForMapPredicate.java b/src/main/java/org/codehaus/groovy/runtime/callsite/BooleanClosureForMapPredicate.java
@@ -24,10 +24,10 @@
 import java.util.function.Predicate;
 
 /**
- * Helper class for internal use only.
- * This creates a Predicate by calling a {@link Closure} and converting the result to a boolean.
- * {@link BooleanReturningMethodInvoker} is used for caching.
+ * @deprecated Use {@link org.codehaus.groovy.runtime.BooleanClosureForMapPredicate} instead.
  */
+@Deprecated(since = "6.0.0", forRemoval = true)
+@SuppressWarnings("removal")
 public class BooleanClosureForMapPredicate<K, V> implements Predicate<Map.Entry<K, V>> {
     private final BooleanReturningMethodInvoker bmi;
     private final Closure wrapped;
@@ -39,21 +39,12 @@ public BooleanClosureForMapPredicate(Closure wrapped) {
         numberOfArguments = wrapped.getMaximumNumberOfParameters();
     }
 
-    private boolean call(Object... args) {
-        return bmi.invoke(wrapped, args);
-    }
-
-    /**
-     * If the call to the backing {@link Closure} is done on a {@link Closure}
-     * taking one argument, then we give in the {@link Map.Entry}, otherwise we will
-     * give in the key and value.
-     */
     @Override
     public boolean test(Map.Entry<K, V> entry) {
         if (numberOfArguments == 2) {
-            return call(entry.getKey(), entry.getValue());
+            return bmi.invoke(wrapped, entry.getKey(), entry.getValue());
         } else {
-            return call(entry);
+            return bmi.invoke(wrapped, entry);
         }
     }
 }
diff --git a/src/main/java/org/codehaus/groovy/runtime/callsite/BooleanClosurePredicate.java b/src/main/java/org/codehaus/groovy/runtime/callsite/BooleanClosurePredicate.java
@@ -23,10 +23,10 @@
 import java.util.function.Predicate;
 
 /**
- * Helper class for internal use only.
- * This creates a Predicate by calling a {@link Closure} and converting the result to a boolean.
- * {@link BooleanReturningMethodInvoker} is used for caching.
+ * @deprecated Use {@link org.codehaus.groovy.runtime.BooleanClosurePredicate} instead.
  */
+@Deprecated(since = "6.0.0", forRemoval = true)
+@SuppressWarnings("removal")
 public class BooleanClosurePredicate<T> implements Predicate<T> {
     private final BooleanReturningMethodInvoker bmi;
     private final Closure wrapped;
diff --git a/src/main/java/org/codehaus/groovy/runtime/callsite/BooleanClosureWrapper.java b/src/main/java/org/codehaus/groovy/runtime/callsite/BooleanClosureWrapper.java
@@ -24,16 +24,19 @@
 import java.util.Map.Entry;
 
 /**
- * Helper class for internal use only. This allows to call a {@link Closure} and 
+ * Helper class for internal use only. This allows to call a {@link Closure} and
  * convert the result to a boolean. It will do this by caching the possible "doCall"
- * as well as the "asBoolean" in CallSiteArray fashion. "asBoolean" will not be 
+ * as well as the "asBoolean" in CallSiteArray fashion. "asBoolean" will not be
  * called if the result is null or a Boolean. In case of null we return false and
- * in case of a Boolean we simply unbox. This logic is designed after the one present 
+ * in case of a Boolean we simply unbox. This logic is designed after the one present
  * in {@link org.codehaus.groovy.runtime.typehandling.DefaultTypeTransformation#castToBoolean(Object)}. The purpose of
  * this class is to avoid the slow "asBoolean" call in that method.
  * {@link BooleanReturningMethodInvoker} is used for caching.
  *
+ * @deprecated Use {@link org.codehaus.groovy.runtime.BooleanClosureWrapper} instead.
  */
+@Deprecated(since = "6.0.0", forRemoval = true)
+@SuppressWarnings("removal")
 public class BooleanClosureWrapper {
     private final BooleanReturningMethodInvoker bmi;
     private final Closure wrapped;
diff --git a/src/main/java/org/codehaus/groovy/runtime/callsite/BooleanReturningMethodInvoker.java b/src/main/java/org/codehaus/groovy/runtime/callsite/BooleanReturningMethodInvoker.java
@@ -32,6 +32,7 @@
  * The nature of this class allows a per instance caching instead of a per class
  * caching like the normal {@link CallSiteArray} logic.
  */
+@Deprecated(since = "6.0.0", forRemoval = true)
 public class BooleanReturningMethodInvoker {
     private final CallSiteArray csa;
 
diff --git a/subprojects/groovy-nio/src/main/java/org/apache/groovy/nio/extensions/NioExtensions.java b/subprojects/groovy-nio/src/main/java/org/apache/groovy/nio/extensions/NioExtensions.java
@@ -35,7 +35,6 @@
 import org.codehaus.groovy.runtime.FormatHelper;
 import org.codehaus.groovy.runtime.IOGroovyMethods;
 import org.codehaus.groovy.runtime.InvokerHelper;
-import org.codehaus.groovy.runtime.callsite.BooleanReturningMethodInvoker;
 import org.codehaus.groovy.runtime.typehandling.DefaultTypeTransformation;
 
 import java.io.BufferedInputStream;
@@ -1326,12 +1325,11 @@ public static void eachFileMatch(final Path self, final FileType fileType, final
         checkDir(self);
         try (DirectoryStream<Path> stream = Files.newDirectoryStream(self)) {
             Iterator<Path> itr = stream.iterator();
-            BooleanReturningMethodInvoker bmi = new BooleanReturningMethodInvoker("isCase");
             while (itr.hasNext()) {
                 Path currentPath = itr.next();
                 if ((fileType != FileType.FILES && Files.isDirectory(currentPath)) ||
                         (fileType != FileType.DIRECTORIES && Files.isRegularFile(currentPath))) {
-                    if (bmi.invoke(nameFilter, currentPath.getFileName().toString()))
+                    if (DefaultTypeTransformation.castToBoolean(InvokerHelper.invokeMethod(nameFilter, "isCase", currentPath.getFileName().toString())))
                         closure.call(currentPath);
                 }
             }
