8248383: Clarify java.io.Reader.read(char[], ...) behavior for full a…

…rray

Reviewed-by: naoto, smarks, rriggs

src/java.base/share/classes/java/io/Reader.java

@@ -217,6 +217,12 @@ public int read() throws IOException {
      * Reads characters into an array.  This method will block until some input
      * is available, an I/O error occurs, or the end of the stream is reached.
      *
+     * <p> If the length of {@code cbuf} is zero, then no characters are read
+     * and {@code 0} is returned; otherwise, there is an attempt to read at
+     * least one character.  If no character is available because the stream is
+     * at its end, the value {@code -1} is returned; otherwise, at least one
+     * character is read and stored into {@code cbuf}.
+     *
      * @param       cbuf  Destination buffer
      *
      * @return      The number of characters read, or -1
@@ -234,6 +240,12 @@ public int read(char cbuf[]) throws IOException {
      * until some input is available, an I/O error occurs, or the end of the
      * stream is reached.
      *
+     * <p> If {@code len} is zero, then no characters are read and {@code 0} is
+     * returned; otherwise, there is an attempt to read at least one character.
+     * If no character is available because the stream is at its end, the value
+     * {@code -1} is returned; otherwise, at least one character is read and
+     * stored into {@code cbuf}.
+     *
      * @param      cbuf  Destination buffer
      * @param      off   Offset at which to start storing characters
      * @param      len   Maximum number of characters to read

test/jdk/java/io/Reader/ReadIntoZeroLengthArray.java

@@ -0,0 +1,83 @@
+/*
+ * Copyright (c) 2020, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+import java.io.CharArrayReader;
+import java.io.File;
+import java.io.FileReader;
+import java.io.IOException;
+import java.io.LineNumberReader;
+import java.io.PushbackReader;
+import java.io.Reader;
+import java.io.StringReader;
+import org.testng.Assert;
+import org.testng.annotations.AfterTest;
+import org.testng.annotations.BeforeTest;
+import org.testng.annotations.DataProvider;
+import org.testng.annotations.Test;
+
+/*
+ * @test
+ * @bug 8248383
+ * @summary Ensure that zero is returned for read into zero length array
+ * @run testng ReadIntoZeroLengthArray
+ */
+public class ReadIntoZeroLengthArray {
+    private File file;
+
+    private char[] cbuf0;
+    private char[] cbuf1;
+
+    @BeforeTest
+    public void setup() throws IOException {
+        file = File.createTempFile("foo", "bar", new File("."));
+        cbuf0 = new char[0];
+        cbuf1 = new char[1];
+    }
+
+    @AfterTest
+    public void teardown() throws IOException {
+        file.delete();
+    }
+
+    @DataProvider(name = "readers")
+    public Object[][] getReaders() throws IOException {
+        Reader fileReader = new FileReader(file);
+        return new Object[][] {
+            {new LineNumberReader(fileReader)},
+            {new CharArrayReader(new char[] {27})},
+            {new PushbackReader(fileReader)},
+            {fileReader},
+            {new StringReader(new String(new byte[] {(byte)42}))}
+        };
+    }
+
+    @Test(dataProvider = "readers")
+    void test0(Reader r) throws IOException {
+        Assert.assertEquals(r.read(cbuf0), 0);
+    }
+
+    @Test(dataProvider = "readers")
+    void test1(Reader r) throws IOException {
+        Assert.assertEquals(r.read(cbuf1, 0, 0), 0);
+    }
+}