core: Delete ReadableBuffer.readBytes(ByteBuffer) (#12580)

ejona86 · web-flow · commit 738782fb050e · 2025-12-22T11:27:23.000-08:00
At the very least it isn't used now. The method is as old as ReadableBuffer itself (05a2b25), but it appears to have never actually been used.
diff --git a/core/src/main/java/io/grpc/internal/CompositeReadableBuffer.java b/core/src/main/java/io/grpc/internal/CompositeReadableBuffer.java
@@ -18,7 +18,6 @@
 
 import java.io.IOException;
 import java.io.OutputStream;
-import java.nio.Buffer;
 import java.nio.ByteBuffer;
 import java.nio.InvalidMarkException;
 import java.util.ArrayDeque;
@@ -120,20 +119,6 @@ public int read(ReadableBuffer buffer, int length, byte[] dest, int offset) {
         }
       };
 
-  private static final NoThrowReadOperation<ByteBuffer> BYTE_BUF_OP =
-      new NoThrowReadOperation<ByteBuffer>() {
-        @Override
-        public int read(ReadableBuffer buffer, int length, ByteBuffer dest, int unused) {
-          // Change the limit so that only lengthToCopy bytes are available.
-          int prevLimit = dest.limit();
-          ((Buffer) dest).limit(dest.position() + length);
-          // Write the bytes and restore the original limit.
-          buffer.readBytes(dest);
-          ((Buffer) dest).limit(prevLimit);
-          return 0;
-        }
-      };
-
   private static final ReadOperation<OutputStream> STREAM_OP =
       new ReadOperation<OutputStream>() {
         @Override
@@ -149,11 +134,6 @@ public void readBytes(byte[] dest, int destOffset, int length) {
     executeNoThrow(BYTE_ARRAY_OP, length, dest, destOffset);
   }
 
-  @Override
-  public void readBytes(ByteBuffer dest) {
-    executeNoThrow(BYTE_BUF_OP, dest.remaining(), dest, 0);
-  }
-
   @Override
   public void readBytes(OutputStream dest, int length) throws IOException {
     execute(STREAM_OP, length, dest, 0);
diff --git a/core/src/main/java/io/grpc/internal/ForwardingReadableBuffer.java b/core/src/main/java/io/grpc/internal/ForwardingReadableBuffer.java
@@ -67,11 +67,6 @@ public void readBytes(byte[] dest, int destOffset, int length) {
     buf.readBytes(dest, destOffset, length);
   }
 
-  @Override
-  public void readBytes(ByteBuffer dest) {
-    buf.readBytes(dest);
-  }
-
   @Override
   public void readBytes(OutputStream dest, int length) throws IOException {
     buf.readBytes(dest, length);
diff --git a/core/src/main/java/io/grpc/internal/ReadableBuffer.java b/core/src/main/java/io/grpc/internal/ReadableBuffer.java
@@ -71,15 +71,6 @@ public interface ReadableBuffer extends Closeable {
    */
   void readBytes(byte[] dest, int destOffset, int length);
 
-  /**
-   * Reads from this buffer until the destination's position reaches its limit, and increases the
-   * read position by the number of the transferred bytes.
-   *
-   * @param dest the destination buffer to receive the bytes.
-   * @throws IndexOutOfBoundsException if required bytes are not readable
-   */
-  void readBytes(ByteBuffer dest);
-
   /**
    * Reads {@code length} bytes from this buffer and writes them to the destination stream.
    * Increments the read position by {@code length}. If the required bytes are not readable, throws
diff --git a/core/src/main/java/io/grpc/internal/ReadableBuffers.java b/core/src/main/java/io/grpc/internal/ReadableBuffers.java
@@ -171,15 +171,6 @@ public void readBytes(byte[] dest, int destIndex, int length) {
       offset += length;
     }
 
-    @Override
-    public void readBytes(ByteBuffer dest) {
-      Preconditions.checkNotNull(dest, "dest");
-      int length = dest.remaining();
-      checkReadable(length);
-      dest.put(bytes, offset, length);
-      offset += length;
-    }
-
     @Override
     public void readBytes(OutputStream dest, int length) throws IOException {
       checkReadable(length);
@@ -262,21 +253,6 @@ public void readBytes(byte[] dest, int destOffset, int length) {
       bytes.get(dest, destOffset, length);
     }
 
-    @Override
-    public void readBytes(ByteBuffer dest) {
-      Preconditions.checkNotNull(dest, "dest");
-      int length = dest.remaining();
-      checkReadable(length);
-
-      // Change the limit so that only length bytes are available.
-      int prevLimit = bytes.limit();
-      ((Buffer) bytes).limit(bytes.position() + length);
-
-      // Write the bytes and restore the original limit.
-      dest.put(bytes);
-      bytes.limit(prevLimit);
-    }
-
     @Override
     public void readBytes(OutputStream dest, int length) throws IOException {
       checkReadable(length);
diff --git a/core/src/test/java/io/grpc/internal/CompositeReadableBufferTest.java b/core/src/test/java/io/grpc/internal/CompositeReadableBufferTest.java
@@ -28,8 +28,6 @@
 
 import java.io.ByteArrayOutputStream;
 import java.io.IOException;
-import java.nio.Buffer;
-import java.nio.ByteBuffer;
 import java.nio.InvalidMarkException;
 import org.junit.After;
 import org.junit.Before;
@@ -121,27 +119,6 @@ public void readByteArrayShouldSucceed() {
     assertEquals(EXPECTED_VALUE, new String(bytes, UTF_8));
   }
 
-  @Test
-  public void readByteBufferShouldSucceed() {
-    ByteBuffer byteBuffer = ByteBuffer.allocate(EXPECTED_VALUE.length());
-    int remaining = EXPECTED_VALUE.length();
-
-    ((Buffer) byteBuffer).limit(1);
-    composite.readBytes(byteBuffer);
-    remaining--;
-    assertEquals(remaining, composite.readableBytes());
-
-    ((Buffer) byteBuffer).limit(byteBuffer.limit() + 5);
-    composite.readBytes(byteBuffer);
-    remaining -= 5;
-    assertEquals(remaining, composite.readableBytes());
-
-    ((Buffer) byteBuffer).limit(byteBuffer.limit() + remaining);
-    composite.readBytes(byteBuffer);
-    assertEquals(0, composite.readableBytes());
-    assertEquals(EXPECTED_VALUE, new String(byteBuffer.array(), UTF_8));
-  }
-
   @Test
   public void readStreamShouldSucceed() throws IOException {
     ByteArrayOutputStream bos = new ByteArrayOutputStream();
@@ -216,18 +193,6 @@ public void markAndResetWithReadByteArrayShouldSucceed() {
     assertArrayEquals(first, second);
   }
 
-  @Test
-  public void markAndResetWithReadByteBufferShouldSucceed() {
-    byte[] first = new byte[EXPECTED_VALUE.length()];
-    composite.mark();
-    composite.readBytes(ByteBuffer.wrap(first));
-    composite.reset();
-    byte[] second = new byte[EXPECTED_VALUE.length()];
-    assertEquals(EXPECTED_VALUE.length(), composite.readableBytes());
-    composite.readBytes(ByteBuffer.wrap(second));
-    assertArrayEquals(first, second);
-  }
-
   @Test
   public void markAndResetWithReadStreamShouldSucceed() throws IOException {
     ByteArrayOutputStream first = new ByteArrayOutputStream();
diff --git a/core/src/test/java/io/grpc/internal/ForwardingReadableBufferTest.java b/core/src/test/java/io/grpc/internal/ForwardingReadableBufferTest.java
@@ -25,7 +25,6 @@
 import java.io.IOException;
 import java.io.OutputStream;
 import java.lang.reflect.Method;
-import java.nio.ByteBuffer;
 import java.util.Collections;
 import org.junit.Before;
 import org.junit.Rule;
@@ -91,14 +90,6 @@ public void readBytes() {
     verify(delegate).readBytes(dest, 1, 2);
   }
 
-  @Test
-  public void readBytes_overload1() {
-    ByteBuffer dest = ByteBuffer.allocate(0);
-    buffer.readBytes(dest);
-
-    verify(delegate).readBytes(dest);
-  }
-
   @Test
   public void readBytes_overload2() throws IOException {
     OutputStream dest = mock(OutputStream.class);
diff --git a/core/src/testFixtures/java/io/grpc/internal/ReadableBufferTestBase.java b/core/src/testFixtures/java/io/grpc/internal/ReadableBufferTestBase.java
@@ -21,7 +21,6 @@
 import static org.junit.Assert.assertEquals;
 
 import java.io.ByteArrayOutputStream;
-import java.nio.Buffer;
 import java.nio.ByteBuffer;
 import java.util.Arrays;
 import org.junit.Assume;
@@ -83,30 +82,6 @@ public void partialReadToStreamShouldSucceed() throws Exception {
     assertEquals(msg.length() - 2, buffer.readableBytes());
   }
 
-  @Test
-  public void readToByteBufferShouldSucceed() {
-    ReadableBuffer buffer = buffer();
-    ByteBuffer byteBuffer = ByteBuffer.allocate(msg.length());
-    buffer.readBytes(byteBuffer);
-    ((Buffer) byteBuffer).flip();
-    byte[] array = new byte[msg.length()];
-    byteBuffer.get(array);
-    assertArrayEquals(msg.getBytes(UTF_8), array);
-    assertEquals(0, buffer.readableBytes());
-  }
-
-  @Test
-  public void partialReadToByteBufferShouldSucceed() {
-    ReadableBuffer buffer = buffer();
-    ByteBuffer byteBuffer = ByteBuffer.allocate(2);
-    buffer.readBytes(byteBuffer);
-    ((Buffer) byteBuffer).flip();
-    byte[] array = new byte[2];
-    byteBuffer.get(array);
-    assertArrayEquals(new byte[]{'h', 'e'}, array);
-    assertEquals(msg.length() - 2, buffer.readableBytes());
-  }
-
   @Test
   public void partialReadToReadableBufferShouldSucceed() {
     ReadableBuffer buffer = buffer();
diff --git a/netty/src/main/java/io/grpc/netty/NettyReadableBuffer.java b/netty/src/main/java/io/grpc/netty/NettyReadableBuffer.java
@@ -60,11 +60,6 @@ public void readBytes(byte[] dest, int index, int length) {
     buffer.readBytes(dest, index, length);
   }
 
-  @Override
-  public void readBytes(ByteBuffer dest) {
-    buffer.readBytes(dest);
-  }
-
   @Override
   public void readBytes(OutputStream dest, int length) {
     try {
diff --git a/okhttp/src/main/java/io/grpc/okhttp/OkHttpReadableBuffer.java b/okhttp/src/main/java/io/grpc/okhttp/OkHttpReadableBuffer.java
@@ -21,7 +21,6 @@
 import java.io.EOFException;
 import java.io.IOException;
 import java.io.OutputStream;
-import java.nio.ByteBuffer;
 
 /**
  * A {@link ReadableBuffer} implementation that is backed by an {@link okio.Buffer}.
@@ -71,12 +70,6 @@ public void readBytes(byte[] dest, int destOffset, int length) {
     }
   }
 
-  @Override
-  public void readBytes(ByteBuffer dest) {
-    // We are not using it.
-    throw new UnsupportedOperationException();
-  }
-
   @Override
   public void readBytes(OutputStream dest, int length) throws IOException {
     buffer.writeTo(dest, length);
diff --git a/okhttp/src/test/java/io/grpc/okhttp/OkHttpReadableBufferTest.java b/okhttp/src/test/java/io/grpc/okhttp/OkHttpReadableBufferTest.java
@@ -44,18 +44,6 @@ public void setup() {
     }
   }
 
-  @Override
-  @Test
-  public void readToByteBufferShouldSucceed() {
-    // Not supported.
-  }
-
-  @Override
-  @Test
-  public void partialReadToByteBufferShouldSucceed() {
-    // Not supported.
-  }
-
   @Override
   @Test
   public void markAndResetWithReadShouldSucceed() {
