[IO-426] Add API IOUtils.closeQuietly(Closeable...)

garydgregory · garydgregory · commit 583638baf42a · 2014-02-06T16:02:20.000Z
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/io/trunk@1565317 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
@@ -47,6 +47,9 @@ The <action> type attribute can be add,update,fix,remove.
   <body>
     <!-- The release date is the date RC is cut -->
     <release version="2.5" date="2014-??-??" description="New features and bug fixes.">
+      <action issue="IO-426" dev="ggregory" type="add">
+         Add API IOUtils.closeQuietly(Closeable...)
+      </action>
       <action issue="IO-424" dev="ggregory" type="fix" due-to="Ville Skyttä">
          Javadoc fixes, mostly to appease 1.8.0
       </action>
diff --git a/src/main/java/org/apache/commons/io/FileUtils.java b/src/main/java/org/apache/commons/io/FileUtils.java
@@ -1161,10 +1161,7 @@ private static void doCopyFile(final File srcFile, final File destFile, final bo
                 pos += bytesCopied;
             }
         } finally {
-            IOUtils.closeQuietly(output);
-            IOUtils.closeQuietly(fos);
-            IOUtils.closeQuietly(input);
-            IOUtils.closeQuietly(fis);
+            IOUtils.closeQuietly(output, fos, input, fis);
         }
 
         final long srcLen = srcFile.length(); // TODO See IO-386
diff --git a/src/main/java/org/apache/commons/io/IOUtils.java b/src/main/java/org/apache/commons/io/IOUtils.java
@@ -281,24 +281,37 @@ public static void closeQuietly(final OutputStream output) {
     /**
      * Closes a <code>Closeable</code> unconditionally.
      * <p>
-     * Equivalent to {@link Closeable#close()}, except any exceptions will be ignored.
-     * This is typically used in finally blocks.
+     * Equivalent to {@link Closeable#close()}, except any exceptions will be ignored. This is typically used in
+     * finally blocks.
      * <p>
      * Example code:
+     * 
      * <pre>
-     *   Closeable closeable = null;
-     *   try {
-     *       closeable = new FileReader("foo.txt");
-     *       // process closeable
-     *       closeable.close();
-     *   } catch (Exception e) {
-     *       // error handling
-     *   } finally {
-     *       IOUtils.closeQuietly(closeable);
-     *   }
+     * Closeable closeable = null;
+     * try {
+     *     closeable = new FileReader(&quot;foo.txt&quot;);
+     *     // process closeable
+     *     closeable.close();
+     * } catch (Exception e) {
+     *     // error handling
+     * } finally {
+     *     IOUtils.closeQuietly(closeable);
+     * }
      * </pre>
-     *
-     * @param closeable the object to close, may be null or already closed
+     * 
+     * Closing all streams:
+     * 
+     * <pre>
+     * try {
+     *     return IOUtils.copy(inputStream, outputStream);
+     * } finally {
+     *     IOUtils.closeQuietly(inputStream);
+     *     IOUtils.closeQuietly(outputStream);
+     * }
+     * </pre>
+     * 
+     * @param closeable
+     *            the objects to close, may be null or already closed
      * @since 2.0
      */
     public static void closeQuietly(final Closeable closeable) {
@@ -311,6 +324,51 @@ public static void closeQuietly(final Closeable closeable) {
         }
     }
 
+    /**
+     * Closes a <code>Closeable</code> unconditionally.
+     * <p>
+     * Equivalent to {@link Closeable#close()}, except any exceptions will be ignored. This is typically used in
+     * finally blocks.
+     * <p>
+     * Example code:
+     * 
+     * <pre>
+     * Closeable closeable = null;
+     * try {
+     *     closeable = new FileReader(&quot;foo.txt&quot;);
+     *     // process closeable
+     *     closeable.close();
+     * } catch (Exception e) {
+     *     // error handling
+     * } finally {
+     *     IOUtils.closeQuietly(closeable);
+     * }
+     * </pre>
+     * 
+     * Closing all streams:
+     * 
+     * <pre>
+     * try {
+     *     return IOUtils.copy(inputStream, outputStream);
+     * } finally {
+     *     IOUtils.closeQuietly(inputStream);
+     *     IOUtils.closeQuietly(outputStream);
+     * }
+     * </pre>
+     * 
+     * @param closeables
+     *            the objects to close, may be null or already closed
+     * @since 2.5
+     */
+    public static void closeQuietly(final Closeable... closeables) {
+        if (closeables == null) {
+            return;
+        }
+        for (final Closeable closeable : closeables) {
+            closeQuietly(closeable);
+        }
+    }
+
     /**
      * Closes a <code>Socket</code> unconditionally.
      * <p>
diff --git a/src/test/java/org/apache/commons/io/IOUtilsTestCase.java b/src/test/java/org/apache/commons/io/IOUtilsTestCase.java
@@ -124,6 +124,15 @@ public void tearDown() {
         }
     }
 
+    public void testCloseQuietly_AllCloseableIOException() {
+        final Closeable closeable = new Closeable() {
+            public void close() throws IOException {
+                throw new IOException();
+            }
+        };
+        IOUtils.closeQuietly(closeable, null, closeable);
+    }
+
     public void testCloseQuietly_CloseableIOException() {
         IOUtils.closeQuietly(new Closeable() {
             public void close() throws IOException {
@@ -614,8 +623,7 @@ public void testRead_ReadableByteChannel() throws Exception {
                 // expected
             }
         } finally {
-            IOUtils.closeQuietly(input);
-            IOUtils.closeQuietly(fileInputStream);
+            IOUtils.closeQuietly(input, fileInputStream);
         }}
 
     public void testReadFully_InputStream_ByteArray() throws Exception {
@@ -684,8 +692,7 @@ public void testReadFully_ReadableByteChannel() throws Exception {
                 // expected
             }
         } finally {
-            IOUtils.closeQuietly(input);
-            IOUtils.closeQuietly(fileInputStream);
+            IOUtils.closeQuietly(input, fileInputStream);
         }
     }
 
@@ -802,8 +809,7 @@ public void testSkip_ReadableByteChannel() throws Exception {
             assertEquals(10, IOUtils.skip(fileChannel, 20));
             assertEquals(0, IOUtils.skip(fileChannel, 10));
         } finally {
-            IOUtils.closeQuietly(fileChannel);
-            IOUtils.closeQuietly(fileInputStream);
+            IOUtils.closeQuietly(fileChannel, fileInputStream);
         }
     }
 
@@ -848,8 +854,7 @@ public void testSkipFully_ReadableByteChannel() throws Exception {
                 // expected
             }
         } finally {
-            IOUtils.closeQuietly(fileChannel);
-            IOUtils.closeQuietly(fileInputStream);
+            IOUtils.closeQuietly(fileChannel, fileInputStream);
         }
     }
 

Original file line number	Diff line number	Diff line change
`@@ -1161,10 +1161,7 @@ private static void doCopyFile(final File srcFile, final File destFile, final bo`
`1161`	`1161`	`pos += bytesCopied;`
`1162`	`1162`	`}`
`1163`	`1163`	`} finally {`
`1164`		`- IOUtils.closeQuietly(output);`
`1165`		`- IOUtils.closeQuietly(fos);`
`1166`		`- IOUtils.closeQuietly(input);`
`1167`		`- IOUtils.closeQuietly(fis);`
	`1164`	`+ IOUtils.closeQuietly(output, fos, input, fis);`
`1168`	`1165`	`}`
`1169`	`1166`
`1170`	`1167`	`final long srcLen = srcFile.length(); // TODO See IO-386`
Original file line number	Diff line number	Diff line change
`@@ -124,6 +124,15 @@ public void tearDown() {`
`124`	`124`	`}`
`125`	`125`	`}`
`126`	`126`
	`127`	`+ public void testCloseQuietly_AllCloseableIOException() {`
	`128`	`+ final Closeable closeable = new Closeable() {`
	`129`	`+ public void close() throws IOException {`
	`130`	`+ throw new IOException();`
	`131`	`+ }`
	`132`	`+ };`
	`133`	`+ IOUtils.closeQuietly(closeable, null, closeable);`
	`134`	`+ }`
	`135`	`+`
`127`	`136`	`public void testCloseQuietly_CloseableIOException() {`
`128`	`137`	`IOUtils.closeQuietly(new Closeable() {`
`129`	`138`	`public void close() throws IOException {`
`@@ -614,8 +623,7 @@ public void testRead_ReadableByteChannel() throws Exception {`
`614`	`623`	`// expected`
`615`	`624`	`}`
`616`	`625`	`} finally {`
`617`		`- IOUtils.closeQuietly(input);`
`618`		`- IOUtils.closeQuietly(fileInputStream);`
	`626`	`+ IOUtils.closeQuietly(input, fileInputStream);`
`619`	`627`	`}}`
`620`	`628`
`621`	`629`	`public void testReadFully_InputStream_ByteArray() throws Exception {`
`@@ -684,8 +692,7 @@ public void testReadFully_ReadableByteChannel() throws Exception {`
`684`	`692`	`// expected`
`685`	`693`	`}`
`686`	`694`	`} finally {`
`687`		`- IOUtils.closeQuietly(input);`
`688`		`- IOUtils.closeQuietly(fileInputStream);`
	`695`	`+ IOUtils.closeQuietly(input, fileInputStream);`
`689`	`696`	`}`
`690`	`697`	`}`
`691`	`698`
`@@ -802,8 +809,7 @@ public void testSkip_ReadableByteChannel() throws Exception {`
`802`	`809`	`assertEquals(10, IOUtils.skip(fileChannel, 20));`
`803`	`810`	`assertEquals(0, IOUtils.skip(fileChannel, 10));`
`804`	`811`	`} finally {`
`805`		`- IOUtils.closeQuietly(fileChannel);`
`806`		`- IOUtils.closeQuietly(fileInputStream);`
	`812`	`+ IOUtils.closeQuietly(fileChannel, fileInputStream);`
`807`	`813`	`}`
`808`	`814`	`}`
`809`	`815`
`@@ -848,8 +854,7 @@ public void testSkipFully_ReadableByteChannel() throws Exception {`
`848`	`854`	`// expected`
`849`	`855`	`}`
`850`	`856`	`} finally {`
`851`		`- IOUtils.closeQuietly(fileChannel);`
`852`		`- IOUtils.closeQuietly(fileInputStream);`
	`857`	`+ IOUtils.closeQuietly(fileChannel, fileInputStream);`
`853`	`858`	`}`
`854`	`859`	`}`
`855`	`860`