Merge pull request square#63 from square/jw/read-to-byte-array

JakeWharton · JakeWharton · commit 1a80a4f6b6d3 · 2014-06-12T22:33:06.000-07:00
Read methods to copy data into external byte[] sinks.
diff --git a/okio/src/main/java/okio/Buffer.java b/okio/src/main/java/okio/Buffer.java
@@ -482,11 +482,20 @@ String readUtf8Line(long newline) {
     return result;
   }
 
-  /** Like {@link InputStream#read}. */
-  int read(byte[] sink, int offset, int byteCount) {
+  @Override public int read(byte[] sink) {
+    return read(sink, 0, sink.length);
+  }
+
+  @Override public int read(byte[] sink, long byteCount) {
+    return read(sink, 0, byteCount);
+  }
+
+  @Override public int read(byte[] sink, int offset, long byteCount) {
+    checkOffsetAndCount(sink.length, offset, byteCount);
+
     Segment s = this.head;
     if (s == null) return -1;
-    int toCopy = Math.min(byteCount, s.limit - s.pos);
+    int toCopy = Math.min((int) byteCount, s.limit - s.pos);
     System.arraycopy(s.data, s.pos, sink, offset, toCopy);
 
     s.pos += toCopy;
diff --git a/okio/src/main/java/okio/BufferedSource.java b/okio/src/main/java/okio/BufferedSource.java
@@ -81,6 +81,24 @@ public interface BufferedSource extends Source {
   /** Removes {@code byteCount} bytes from this and returns them as a byte array. */
   byte[] readByteArray(long byteCount) throws IOException;
 
+  /**
+   * Removes up to {@code sink.length} bytes from this and copies them into {@code sink}.
+   * Returns the number of bytes read, or -1 if this source is exhausted.
+   */
+  int read(byte[] sink) throws IOException;
+
+  /**
+   * Removes up to {@code byteCount} bytes from this and copies them into {@code sink}.
+   * Returns the number of bytes read, or -1 if this source is exhausted.
+   */
+  int read(byte[] sink, long byteCount) throws IOException;
+
+  /**
+   * Removes up to {@code byteCount} bytes from this and copies them into {@code sink} at
+   * {@code offset}. Returns the number of bytes read, or -1 if this source is exhausted.
+   */
+  int read(byte[] sink, int offset, long byteCount) throws IOException;
+
   /**
    * Removes exactly {@code byteCount} bytes from this and appends them to
    * {@code sink}. Throws an {@link java.io.EOFException} if the requested
diff --git a/okio/src/main/java/okio/RealBufferedSource.java b/okio/src/main/java/okio/RealBufferedSource.java
@@ -93,6 +93,26 @@ public RealBufferedSource(Source source) {
     return buffer.readByteArray(byteCount);
   }
 
+  @Override public int read(byte[] sink) throws IOException {
+    return read(sink, 0, sink.length);
+  }
+
+  @Override public int read(byte[] sink, long byteCount) throws IOException {
+    return read(sink, 0, byteCount);
+  }
+
+  @Override public int read(byte[] sink, int offset, long byteCount) throws IOException {
+    checkOffsetAndCount(sink.length, offset, byteCount);
+
+    if (buffer.size == 0) {
+      long read = source.read(buffer, Segment.SIZE);
+      if (read == -1) return -1;
+    }
+
+    long toRead = Math.min(byteCount, buffer.size);
+    return buffer.read(sink, offset, toRead);
+  }
+
   @Override public void readFully(Buffer sink, long byteCount) throws IOException {
     require(byteCount);
     buffer.readFully(sink, byteCount);
diff --git a/okio/src/test/java/okio/RealBufferedSourceTest.java b/okio/src/test/java/okio/RealBufferedSourceTest.java
@@ -276,4 +276,48 @@ public final class RealBufferedSourceTest {
     assertEquals("abc", source.readByteString(3).utf8());
     assertEquals("d", source.readUtf8(1));
   }
+
+  @Test public void readIntoByteArray() throws IOException {
+    Buffer buffer = new Buffer().writeUtf8("abcd");
+    BufferedSource source = Okio.buffer((Source) buffer);
+
+    byte[] sink = new byte[3];
+    int read = source.read(sink);
+    assertEquals(3, read);
+    byte[] expected = { 'a', 'b', 'c' };
+    assertByteArraysEquals(expected, sink);
+  }
+
+  @Test public void readIntoByteArrayNotEnough() throws IOException {
+    Buffer buffer = new Buffer().writeUtf8("abcd");
+    BufferedSource source = Okio.buffer((Source) buffer);
+
+    byte[] sink = new byte[5];
+    int read = source.read(sink);
+    assertEquals(4, read);
+    byte[] expected = { 'a', 'b', 'c', 'd', 0 };
+    assertByteArraysEquals(expected, sink);
+  }
+
+  @Test public void readIntoByteArrayCount() throws IOException {
+    Buffer buffer = new Buffer().writeUtf8("abcd");
+    BufferedSource source = Okio.buffer((Source) buffer);
+
+    byte[] sink = new byte[5];
+    int read = source.read(sink, 3);
+    assertEquals(3, read);
+    byte[] expected = { 'a', 'b', 'c', 0, 0 };
+    assertByteArraysEquals(expected, sink);
+  }
+
+  @Test public void readIntoByteArrayOffsetAndCount() throws IOException {
+    Buffer buffer = new Buffer().writeUtf8("abcd");
+    BufferedSource source = Okio.buffer((Source) buffer);
+
+    byte[] sink = new byte[7];
+    int read = source.read(sink, 2, 3);
+    assertEquals(3, read);
+    byte[] expected = { 0, 0, 'a', 'b', 'c', 0, 0 };
+    assertByteArraysEquals(expected, sink);
+  }
 }
