IO-381 Add FileUtils.copyInputStreamToFile API with option to leave the source open.

garydgregory · garydgregory · commit 1e0666d90d8a · 2013-05-08T14:36:32.000Z
See copyInputStreamToFile(final InputStream source, final File destination, boolean closeSource) git-svn-id: https://svn.apache.org/repos/asf/commons/proper/io/trunk@1480300 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
@@ -47,7 +47,11 @@ 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="2013-??-??" description="New features and bug fixes.">    
-      <action issue="IO-380" dev="sebb" type="fix">
+      <action issue="IO-381" dev="ggregory" type="add">
+        Add FileUtils.copyInputStreamToFile API with option to leave the source open.
+        See copyInputStreamToFile(final InputStream source, final File destination, boolean closeSource)
+      </action>            
+      <action issue="IO-380" dev="sebb" type="fix" due-to="claudio_ch">
         FileUtils.copyInputStreamToFile should document it closes the input source
       </action>            
       <action issue="IO-279" dev="sebb" type="fix">
diff --git a/src/main/java/org/apache/commons/io/FileUtils.java b/src/main/java/org/apache/commons/io/FileUtils.java
@@ -1459,8 +1459,7 @@ private static void doCopyDirectory(final File srcDir, final File destDir, final
      * @throws IOException if an IO error occurs during copying
      */
     public static void copyURLToFile(final URL source, final File destination) throws IOException {
-        final InputStream input = source.openStream();
-        copyInputStreamToFile(input, destination);
+        copyInputStreamToFile(source.openStream(), destination);
     }
 
     /**
@@ -1488,8 +1487,7 @@ public static void copyURLToFile(final URL source, final File destination,
         final URLConnection connection = source.openConnection();
         connection.setConnectTimeout(connectionTimeout);
         connection.setReadTimeout(readTimeout);
-        final InputStream input = connection.getInputStream();
-        copyInputStreamToFile(input, destination);
+        copyInputStreamToFile(connection.getInputStream(), destination);
     }
 
     /**
@@ -1509,6 +1507,27 @@ public static void copyURLToFile(final URL source, final File destination,
      * @since 2.0
      */
     public static void copyInputStreamToFile(final InputStream source, final File destination) throws IOException {
+        copyInputStreamToFile(source, destination, true);
+    }
+
+    /**
+     * Copies bytes from an {@link InputStream} <code>source</code> to a file
+     * <code>destination</code>. The directories up to <code>destination</code>
+     * will be created if they don't already exist. <code>destination</code>
+     * will be overwritten if it already exists.
+     *
+     * @param source  the <code>InputStream</code> to copy bytes from, must not be {@code null}, will be closed
+     * @param destination  the non-directory <code>File</code> to write bytes to
+     *  (possibly overwriting), must not be {@code null}
+     * @param closeSource If true, closes the <code>source</code>
+     * @throws IOException if <code>destination</code> is a directory
+     * @throws IOException if <code>destination</code> cannot be written
+     * @throws IOException if <code>destination</code> needs creating but can't be
+     * @throws IOException if an IO error occurs during copying
+     * @since 2.5
+     */
+    public static void copyInputStreamToFile(final InputStream source, final File destination, boolean closeSource) 
+            throws IOException {
         try {
             final FileOutputStream output = openOutputStream(destination);
             try {
@@ -1518,7 +1537,9 @@ public static void copyInputStreamToFile(final InputStream source, final File de
                 IOUtils.closeQuietly(output);
             }
         } finally {
-            IOUtils.closeQuietly(source);
+            if (closeSource) {
+                IOUtils.closeQuietly(source);
+            }
         }
     }
 
