Add IOIterator.adapt(Iterable)

garydgregory · garydgregory · commit 3ddf1ad58f2e · 2024-05-17T17:16:42.000-04:00
diff --git a/pom.xml b/pom.xml
@@ -24,7 +24,7 @@
   <modelVersion>4.0.0</modelVersion>
   <groupId>commons-io</groupId>
   <artifactId>commons-io</artifactId>
-  <version>2.16.2-SNAPSHOT</version>
+  <version>2.17.0-SNAPSHOT</version>
   <name>Apache Commons IO</name>
 
   <inceptionYear>2002</inceptionYear>
@@ -125,9 +125,9 @@ file comparators, endian transformation classes, and much more.
     <commons.componentid>io</commons.componentid>
     <commons.module.name>org.apache.commons.io</commons.module.name>
     <commons.rc.version>RC2</commons.rc.version>
-    <commons.bc.version>2.16.0</commons.bc.version>
-    <commons.release.version>2.16.1</commons.release.version>
-    <commons.release.next>2.16.2</commons.release.next>
+    <commons.bc.version>2.16.1</commons.bc.version>
+    <commons.release.version>2.17.0</commons.release.version>
+    <commons.release.next>2.17.1</commons.release.next>
     <project.build.outputTimestamp>2024-04-08T16:56:47Z</project.build.outputTimestamp>
     <commons.release.desc>(requires Java 8)</commons.release.desc>
     <commons.jira.id>IO</commons.jira.id>
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
@@ -46,9 +46,10 @@ The <action> type attribute can be add,update,fix,remove.
     <title>Apache Commons IO Release Notes</title>
   </properties>
   <body>
-    <release version="2.16.2" date="YYYY-MM-DD" description="Java 8 is required.">
+    <release version="2.17.0" date="YYYY-MM-DD" description="Java 8 is required.">
       <!-- ADD --> 
       <action dev="ggregory" type="fix"                due-to="sullis">Add test for CircularByteBuffer clear() #620.</action>
+      <action dev="ggregory" type="fix"                due-to="Gary Gregory">Add IOIterator.adapt(Iterable).</action>
       <!-- FIX -->
       <action dev="ggregory" type="fix"                due-to="Dependabot">Add missing unit tests.</action>
       <action dev="ggregory" type="fix"                due-to="Dependabot">FileUtils.lastModifiedFileTime(File) calls Objects.requireNonNull() on the wrong object.</action>
diff --git a/src/main/java/org/apache/commons/io/function/IOIterator.java b/src/main/java/org/apache/commons/io/function/IOIterator.java
@@ -32,6 +32,18 @@
  */
 public interface IOIterator<E> {
 
+    /**
+     * Adapts the given Iterable as an IOIterator.
+     *
+     * @param <E> the type of the stream elements.
+     * @param iterable The iterable to adapt
+     * @return A new IOIterator
+     * @since 2.17.0
+     */
+    static <E> IOIterator<E> adapt(final Iterable<E> iterable) {
+        return IOIteratorAdapter.adapt(iterable.iterator());
+    }
+
     /**
      * Adapts the given Iterator as an IOIterator.
      *
diff --git a/src/test/java/org/apache/commons/io/function/IOIteratorTest.java b/src/test/java/org/apache/commons/io/function/IOIteratorTest.java
@@ -51,10 +51,15 @@ private List<Path> newPathList() {
     }
 
     @Test
-    public void testAdapt() throws IOException {
+    public void testAdaptIterator() throws IOException {
         assertEquals(TestConstants.ABS_PATH_A, iterator.next());
     }
 
+    @Test
+    public void testAdaptIterable() throws IOException {
+        assertEquals(TestConstants.ABS_PATH_A, IOIterator.adapt(newPathList()).next());
+    }
+
     @Test
     public void testAsIterator() {
         final Iterator<Path> asIterator = iterator.asIterator();
