IO-410 Readfully() That Returns A Byte Array

sebbASF · sebbASF · commit 28caccb2f0b5 · 2013-11-25T02:59:40.000Z
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/io/trunk@1545141 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="2013-??-??" description="New features and bug fixes.">    
+      <action issue="IO-410" dev="sebb" type="add" due-to="BELUGA BEHR">
+         Readfully() That Returns A Byte Array
+      </action>
       <action issue="IO-395" dev="brentworden" type="add" due-to="BELUGA BEHR">
          Overload IOUtils buffer methods to accept buffer size
       </action>
diff --git a/src/main/java/org/apache/commons/io/IOUtils.java b/src/main/java/org/apache/commons/io/IOUtils.java
@@ -2966,6 +2966,25 @@ public static void readFully(final InputStream input, final byte[] buffer) throw
         readFully(input, buffer, 0, buffer.length);
     }
 
+    /**
+     * Reads the requested number of bytes or fail if there are not enough left.
+     * <p>
+     * This allows for the possibility that {@link InputStream#read(byte[], int, int)} may
+     * not read as many bytes as requested (most likely because of reaching EOF).
+     *
+     * @param input where to read input from
+     * @param length length to read, must be >= 0
+     *
+     * @throws IOException if there is a problem reading the file
+     * @throws IllegalArgumentException if length is negative
+     * @throws EOFException if the number of bytes read was incorrect
+     */
+    public static byte[] readFully(final InputStream input, final int length) throws IOException {
+        final byte[] buffer = new byte[length];
+        readFully(input, buffer, 0, buffer.length);
+        return buffer;
+    }
+
     /**
      * Reads the requested number of bytes or fail if there are not enough left.
      * <p>
diff --git a/src/test/java/org/apache/commons/io/IOUtilsTestCase.java b/src/test/java/org/apache/commons/io/IOUtilsTestCase.java
@@ -642,6 +642,17 @@ public void testReadFully_InputStream_ByteArray() throws Exception {
 
     }
 
+    public void testReadFully_InputStream__ReturnByteArray() throws Exception {
+        final byte[] bytes = "abcd1234".getBytes("UTF-8");
+        final ByteArrayInputStream stream = new ByteArrayInputStream(bytes);
+        
+        final byte[] result = IOUtils.readFully(stream, bytes.length);
+        
+        IOUtils.closeQuietly(stream);
+        
+        assertEqualContent(result, bytes);
+    }
+
     public void testReadFully_InputStream_Offset() throws Exception {
         final byte[] bytes = "abcd1234".getBytes("UTF-8");
         final ByteArrayInputStream stream = new ByteArrayInputStream(bytes);
