Add IOIterable.asIterable()

Author: garydgregory

src/changes/changes.xml

@@ -64,6 +64,7 @@ The <action> type attribute can be add,update,fix,remove.
       <action dev="pkarwasz" type="add"                due-to="Piotr P. Karwasz">Add IOUtils.toByteArray(InputStream, int, int) for safer chunked reading with size validation.</action>
       <action dev="pkarwasz" type="add"                due-to="Piotr P. Karwasz">Add org.apache.commons.io.file.PathUtils.getPath(String, String).</action>
       <action dev="ggregory" type="add"                due-to="Gary Gregory">Add org.apache.commons.io.channels.ByteArraySeekableByteChannel.</action>
+      <action dev="ggregory" type="add"                due-to="Gary Gregory">Add IOIterable.asIterable().</action>
       <!-- UPDATE -->
       <action type="update" dev="ggregory"             due-to="Gary Gregory, Dependabot">Bump org.apache.commons:commons-parent from 85 to 88 #774, #783.</action>
       <action type="update" dev="ggregory"             due-to="Gary Gregory">[test] Bump commons-codec:commons-codec from 1.18.0 to 1.19.0.</action>

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

@@ -18,6 +18,7 @@
 package org.apache.commons.io.function;
 
 import java.io.IOException;
+import java.io.UncheckedIOException;
 import java.util.Objects;
 
 /**
@@ -28,6 +29,17 @@
  */
 public interface IOIterable<T> {
 
+    /**
+     * Creates an {@link Iterable} for this instance that throws {@link UncheckedIOException} instead of
+     * {@link IOException}.
+     *
+     * @return an {@link UncheckedIOException} {@link Iterable}.
+     * @since 2.21.0
+     */
+    default Iterable<T> asIterable() {
+        return new UncheckedIOIterable<>(this);
+    }
+
     /**
      * Like {@link Iterable#iterator()}.
      *

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

@@ -61,6 +61,13 @@ public void beforeEach() {
         iterable = fixture;
     }
 
+    @Test
+    void testAsIterable() throws IOException {
+        final AtomicInteger ref = new AtomicInteger();
+        iterable.asIterable().iterator().forEachRemaining(e -> ref.incrementAndGet());
+        assertEquals(2, ref.get());
+    }
+
     @Test
     void testForEach() throws IOException {
         final AtomicInteger ref = new AtomicInteger();