Add IOBooleanSupplier

- Add Uncheck.getAsBoolean(IOBooleanSupplier)
- Use Uncheck.getAsBoolean(IOBooleanSupplier) to avoid boxing and
unboxing of boolean values

Author: garydgregory

src/changes/changes.xml

@@ -57,6 +57,7 @@ The <action> type attribute can be add,update,fix,remove.
       <action dev="ggregory" type="fix" issue="IO-868" due-to="Julian Reschke, Gary Gregory">Improve Javadoc for all implementations of AbstractOriginSupplier#get().</action>
       <action dev="ggregory" type="fix"                due-to="Gary Gregory">The Consumer to IOUtils.closeQuietly(Closeable, Consumer) now accepts Exception, not just IOException.</action>
       <action dev="ggregory" type="fix"                due-to="Gary Gregory">The Consumer to IOUtils.close(Closeable, IOConsumer) now accepts wrapped Exception, not just IOException.</action>
+      <action dev="ggregory" type="fix"                due-to="Gary Gregory">Use Uncheck.getAsBoolean(IOBooleanSupplier) to avoid boxing and unboxing of boolean values.</action>
       <!-- ADD -->
       <action dev="ggregory" type="add" issue="IO-860" due-to="Nico Strecker, Gary Gregory">Add ThrottledInputStream.Builder.setMaxBytes(long, ChronoUnit).</action>
       <action dev="ggregory" type="add"                due-to="Gary Gregory">Add IOIterable.</action>
@@ -70,6 +71,8 @@ The <action> type attribute can be add,update,fix,remove.
       <action dev="ggregory" type="add"                due-to="Gary Gregory">Add ProxyOutputStream.Builder.</action>
       <action dev="ggregory" type="add"                due-to="Gary Gregory">Add ByteOrderMark.matches(int[]).</action>
       <action dev="ggregory" type="add"                due-to="Gary Gregory">Add BrokenOutputStream.BrokenOutputStream(Function&lt;String&gt;, Throwable>) and deprecate Supplier&lt;String&gt; constructor.</action>
+      <action dev="ggregory" type="add"                due-to="Gary Gregory">Add IOBooleanSupplier.</action>
+      <action dev="ggregory" type="add"                due-to="Gary Gregory">Add Uncheck.getAsBoolean(IOBooleanSupplier).</action>
       <!-- UPDATE -->
       <action dev="ggregory" type="update"             due-to="Dependabot, Gary Gregory">Bump commons.bytebuddy.version from 1.15.10 to 1.17.1 #710, #715, #720.</action>
       <action dev="ggregory" type="update"             due-to="Gary Gregory">Bump commons-codec:commons-codec from 1.17.1 to 1.18.0. #717.</action>

src/main/java/org/apache/commons/io/FileUtils.java

@@ -1729,7 +1729,7 @@ public static boolean isFileNewer(final File file, final ChronoLocalDateTime<?>
     public static boolean isFileNewer(final File file, final ChronoZonedDateTime<?> chronoZonedDateTime) {
         Objects.requireNonNull(file, PROTOCOL_FILE);
         Objects.requireNonNull(chronoZonedDateTime, "chronoZonedDateTime");
-        return Uncheck.get(() -> PathUtils.isNewer(file.toPath(), chronoZonedDateTime));
+        return Uncheck.getAsBoolean(() -> PathUtils.isNewer(file.toPath(), chronoZonedDateTime));
     }
 
     /**
@@ -1758,7 +1758,7 @@ public static boolean isFileNewer(final File file, final Date date) {
      * @throws UncheckedIOException if the reference file doesn't exist.
      */
     public static boolean isFileNewer(final File file, final File reference) {
-        return Uncheck.get(() -> PathUtils.isNewer(file.toPath(), reference.toPath()));
+        return Uncheck.getAsBoolean(() -> PathUtils.isNewer(file.toPath(), reference.toPath()));
     }
 
     /**
@@ -1788,7 +1788,7 @@ public static boolean isFileNewer(final File file, final FileTime fileTime) thro
      */
     public static boolean isFileNewer(final File file, final Instant instant) {
         Objects.requireNonNull(instant, "instant");
-        return Uncheck.get(() -> PathUtils.isNewer(file.toPath(), instant));
+        return Uncheck.getAsBoolean(() -> PathUtils.isNewer(file.toPath(), instant));
     }
 
     /**
@@ -1803,7 +1803,7 @@ public static boolean isFileNewer(final File file, final Instant instant) {
      */
     public static boolean isFileNewer(final File file, final long timeMillis) {
         Objects.requireNonNull(file, PROTOCOL_FILE);
-        return Uncheck.get(() -> PathUtils.isNewer(file.toPath(), timeMillis));
+        return Uncheck.getAsBoolean(() -> PathUtils.isNewer(file.toPath(), timeMillis));
     }
 
     /**
@@ -1971,7 +1971,7 @@ public static boolean isFileOlder(final File file, final Date date) {
      * @throws UncheckedIOException if an I/O error occurs
      */
     public static boolean isFileOlder(final File file, final File reference) throws FileNotFoundException {
-        return Uncheck.get(() -> PathUtils.isOlder(file.toPath(), reference.toPath()));
+        return Uncheck.getAsBoolean(() -> PathUtils.isOlder(file.toPath(), reference.toPath()));
     }
 
     /**
@@ -2000,7 +2000,7 @@ public static boolean isFileOlder(final File file, final FileTime fileTime) thro
      */
     public static boolean isFileOlder(final File file, final Instant instant) {
         Objects.requireNonNull(instant, "instant");
-        return Uncheck.get(() -> PathUtils.isOlder(file.toPath(), instant));
+        return Uncheck.getAsBoolean(() -> PathUtils.isOlder(file.toPath(), instant));
     }
 
     /**
@@ -2015,7 +2015,7 @@ public static boolean isFileOlder(final File file, final Instant instant) {
      */
     public static boolean isFileOlder(final File file, final long timeMillis) {
         Objects.requireNonNull(file, PROTOCOL_FILE);
-        return Uncheck.get(() -> PathUtils.isOlder(file.toPath(), timeMillis));
+        return Uncheck.getAsBoolean(() -> PathUtils.isOlder(file.toPath(), timeMillis));
     }
 
     /**

src/main/java/org/apache/commons/io/function/IOBooleanSupplier.java

@@ -0,0 +1,49 @@
+/*
+ * 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.apache.commons.io.function;
+
+import java.io.IOException;
+import java.io.UncheckedIOException;
+import java.util.function.BooleanSupplier;
+import java.util.function.Supplier;
+
+/**
+ * Like {@link BooleanSupplier} but throws {@link IOException}.
+ *
+ * @since 2.18.0
+ */
+@FunctionalInterface
+public interface IOBooleanSupplier {
+
+    /**
+     * Creates a {@link Supplier} for this instance that throws {@link UncheckedIOException} instead of {@link IOException}.
+     *
+     * @return an UncheckedIOException Supplier.
+     */
+    default BooleanSupplier asBooleanSupplier() {
+        return () -> Uncheck.getAsBoolean(this);
+    }
+
+    /**
+     * Gets a result.
+     *
+     * @return a result
+     * @throws IOException if an I/O error occurs.
+     */
+    boolean getAsBoolean() throws IOException;
+}

src/main/java/org/apache/commons/io/function/Uncheck.java

@@ -233,6 +233,22 @@ public static <T> T get(final IOSupplier<T> supplier, final Supplier<String> mes
         }
     }
 
+    /**
+     * Gets the result from an IO boolean supplier.
+     *
+     * @param supplier Supplies the return value.
+     * @return result from the supplier.
+     * @throws UncheckedIOException if an I/O error occurs.
+     * @since 2.18.0
+     */
+    public static boolean getAsBoolean(final IOBooleanSupplier supplier) {
+        try {
+            return supplier.getAsBoolean();
+        } catch (final IOException e) {
+            throw wrap(e);
+        }
+    }
+
     /**
      * Gets the result from an IO int supplier.
      *

src/main/java/org/apache/commons/io/function/UncheckedIOIterator.java

@@ -45,7 +45,7 @@ final class UncheckedIOIterator<E> implements Iterator<E> {
 
     @Override
     public boolean hasNext() {
-        return Uncheck.get(delegate::hasNext);
+        return Uncheck.getAsBoolean(delegate::hasNext);
     }
 
     @Override

src/main/java/org/apache/commons/io/input/UncheckedBufferedReader.java

@@ -188,7 +188,7 @@ public String readLine() throws UncheckedIOException {
      */
     @Override
     public boolean ready() throws UncheckedIOException {
-        return Uncheck.get(super::ready);
+        return Uncheck.getAsBoolean(super::ready);
     }
 
     /**

src/main/java/org/apache/commons/io/input/UncheckedFilterReader.java

@@ -172,7 +172,7 @@ public int read(final CharBuffer target) throws UncheckedIOException {
      */
     @Override
     public boolean ready() throws UncheckedIOException {
-        return Uncheck.get(super::ready);
+        return Uncheck.getAsBoolean(super::ready);
     }
 
     /**

src/test/java/org/apache/commons/io/function/IOBooleanSupplierTest.java

@@ -0,0 +1,68 @@
+/*
+ * 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.apache.commons.io.function;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNotEquals;
+import static org.junit.jupiter.api.Assertions.assertThrows;
+
+import java.io.IOException;
+import java.io.UncheckedIOException;
+import java.util.concurrent.atomic.AtomicBoolean;
+
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+
+/**
+ * Tests {@link IOBooleanSupplier}.
+ */
+public class IOBooleanSupplierTest {
+
+    private AtomicBoolean atomicBoolean;
+
+    @BeforeEach
+    public void beforeEach() {
+        atomicBoolean = new AtomicBoolean();
+    }
+
+    private boolean getThrowsIO(final IOBooleanSupplier supplier) throws IOException {
+        return supplier.getAsBoolean();
+    }
+
+    private boolean getThrowsNone(final IOBooleanSupplier supplier) {
+        return supplier.asBooleanSupplier().getAsBoolean();
+    }
+
+    @Test
+    public void testAsSupplier() {
+        assertThrows(UncheckedIOException.class, () -> TestConstants.THROWING_IO_BOOLEAN_SUPPLIER.asBooleanSupplier().getAsBoolean());
+        assertEquals(true, getThrowsNone(() -> TestUtils.compareAndSetThrowsIO(atomicBoolean, true)));
+        assertEquals(true, atomicBoolean.get());
+        assertNotEquals(TestConstants.THROWING_IO_BOOLEAN_SUPPLIER.asBooleanSupplier(), TestConstants.THROWING_IO_BOOLEAN_SUPPLIER.asBooleanSupplier());
+    }
+
+    @Test
+    public void testGet() throws IOException {
+        assertThrows(IOException.class, () -> TestConstants.THROWING_IO_BOOLEAN_SUPPLIER.getAsBoolean());
+        assertThrows(IOException.class, () -> {
+            throw new IOException();
+        });
+        assertEquals(true, getThrowsIO(() -> TestUtils.compareAndSetThrowsIO(atomicBoolean, true)));
+        assertEquals(true, atomicBoolean.get());
+    }
+}

src/test/java/org/apache/commons/io/function/TestConstants.java

@@ -38,14 +38,16 @@ final class TestConstants {
 
     static IOBinaryOperator<?> THROWING_IO_BINARY_OPERATOR = (t, u) -> throwIOException();
 
+    static IOBooleanSupplier THROWING_IO_BOOLEAN_SUPPLIER = TestConstants::throwIOException;
+
     static IOComparator<Object> THROWING_IO_COMPARATOR = (t, u) -> throwIOException();
 
     static IOConsumer<Object> THROWING_IO_CONSUMER = t -> throwIOException();
 
-    static IOIntConsumer THROWING_IO_INT_CONSUMER = t -> throwIOException();
-
     static IOFunction<Object, Object> THROWING_IO_FUNCTION = t -> throwIOException();
 
+    static IOIntConsumer THROWING_IO_INT_CONSUMER = t -> throwIOException();
+
     static IOIntSupplier THROWING_IO_INT_SUPPLIER = TestConstants::throwIOException;
 
     static IOLongSupplier THROWING_IO_LONG_SUPPLIER = TestConstants::throwIOException;

src/test/java/org/apache/commons/io/function/TestUtils.java

@@ -18,12 +18,24 @@
 package org.apache.commons.io.function;
 
 import java.io.IOException;
+import java.util.concurrent.atomic.AtomicBoolean;
 import java.util.concurrent.atomic.AtomicInteger;
 import java.util.concurrent.atomic.AtomicLong;
 import java.util.concurrent.atomic.AtomicReference;
 
 final class TestUtils {
 
+    static boolean compareAndSetThrowsIO(final AtomicBoolean ref, final boolean update) throws IOException {
+        return compareAndSetThrowsIO(ref, false, update);
+    }
+
+    static boolean compareAndSetThrowsIO(final AtomicBoolean ref, final boolean expected, final boolean update) throws IOException {
+        if (!ref.compareAndSet(expected, update)) {
+            throw new IOException("Unexpected");
+        }
+        return ref.get(); // same as update
+    }
+
     static int compareAndSetThrowsIO(final AtomicInteger ref, final int update) throws IOException {
         return compareAndSetThrowsIO(ref, 0, update);
     }