ByteArrayInputStream contains
+ * A {@code ByteArrayInputStream} contains
* an internal buffer that contains bytes that
* may be read from the stream. An internal
* counter keeps track of the next byte to
- * be supplied by the read method.
+ * be supplied by the {@code read} method.
*
* Closing a {@code ByteArrayInputStream} has no effect. The methods in
* this class can be called after the stream has been closed without
@@ -40,15 +43,14 @@
* @see java.io.StringBufferInputStream
* @since 1.0
*/
-public
-class ByteArrayInputStream extends InputStream {
+public class ByteArrayInputStream extends InputStream {
/**
* An array of bytes that was provided
- * by the creator of the stream. Elements buf[0]
- * through buf[count-1] are the
+ * by the creator of the stream. Elements {@code buf[0]}
+ * through {@code buf[count-1]} are the
* only bytes that can ever be read from the
- * stream; element buf[pos] is
+ * stream; element {@code buf[pos]} is
* the next byte to be read.
*/
protected byte buf[];
@@ -56,9 +58,9 @@
/**
* The index of the next character to read from the input stream buffer.
* This value should always be nonnegative
- * and not larger than the value of count.
+ * and not larger than the value of {@code count}.
* The next byte to be read from the input stream buffer
- * will be buf[pos].
+ * will be {@code buf[pos]}.
*/
protected int pos;
@@ -66,9 +68,9 @@
* The currently marked position in the stream.
* ByteArrayInputStream objects are marked at position zero by
* default when constructed. They may be marked at another
- * position within the buffer by the mark() method.
+ * position within the buffer by the {@code mark()} method.
* The current buffer position is set to this point by the
- * reset() method.
+ * {@code reset()} method.
*
* If no mark has been set, then the value of mark is the offset
* passed to the constructor (or 0 if the offset was not supplied).
@@ -81,22 +83,22 @@
* The index one greater than the last valid character in the input
* stream buffer.
* This value should always be nonnegative
- * and not larger than the length of buf.
+ * and not larger than the length of {@code buf}.
* It is one greater than the position of
- * the last byte within buf that
+ * the last byte within {@code buf} that
* can ever be read from the input stream buffer.
*/
protected int count;
/**
- * Creates a ByteArrayInputStream
- * so that it uses buf as its
+ * Creates a {@code ByteArrayInputStream}
+ * so that it uses {@code buf} as its
* buffer array.
* The buffer array is not copied.
- * The initial value of pos
- * is 0 and the initial value
- * of count is the length of
- * buf.
+ * The initial value of {@code pos}
+ * is {@code 0} and the initial value
+ * of {@code count} is the length of
+ * {@code buf}.
*
* @param buf the input buffer.
*/
@@ -107,12 +109,12 @@
}
/**
- * Creates ByteArrayInputStream
- * that uses buf as its
- * buffer array. The initial value of pos
- * is offset and the initial value
- * of count is the minimum of offset+length
- * and buf.length.
+ * Creates {@code ByteArrayInputStream}
+ * that uses {@code buf} as its
+ * buffer array. The initial value of {@code pos}
+ * is {@code offset} and the initial value
+ * of {@code count} is the minimum of {@code offset+length}
+ * and {@code buf.length}.
* The buffer array is not copied. The buffer's mark is
* set to the specified offset.
*
@@ -129,56 +131,54 @@
/**
* Reads the next byte of data from this input stream. The value
- * byte is returned as an int in the range
- * 0 to 255. If no byte is available
+ * byte is returned as an {@code int} in the range
+ * {@code 0} to {@code 255}. If no byte is available
* because the end of the stream has been reached, the value
- * -1 is returned.
+ * {@code -1} is returned.
*
- * This read method
+ * This {@code read} method
* cannot block.
*
- * @return the next byte of data, or -1 if the end of the
+ * @return the next byte of data, or {@code -1} if the end of the
* stream has been reached.
*/
+ @Override
public synchronized int read() {
return (pos < count) ? (buf[pos++] & 0xff) : -1;
}
/**
- * Reads up to len bytes of data into an array of bytes
+ * Reads up to {@code len} bytes of data into an array of bytes
* from this input stream.
- * If pos equals count,
- * then -1 is returned to indicate
- * end of file. Otherwise, the number k
+ * If {@code pos} equals {@code count},
+ * then {@code -1} is returned to indicate
+ * end of file. Otherwise, the number {@code k}
* of bytes read is equal to the smaller of
- * len and count-pos.
- * If k is positive, then bytes
- * buf[pos] through buf[pos+k-1]
- * are copied into b[off] through
- * b[off+k-1] in the manner performed
- * by System.arraycopy. The
- * value k is added into pos
- * and k is returned.
+ * {@code len} and {@code count-pos}.
+ * If {@code k} is positive, then bytes
+ * {@code buf[pos]} through {@code buf[pos+k-1]}
+ * are copied into {@code b[off]} through
+ * {@code b[off+k-1]} in the manner performed
+ * by {@code System.arraycopy}. The
+ * value {@code k} is added into {@code pos}
+ * and {@code k} is returned.
*
- * This read method cannot block.
+ * This {@code read} method cannot block.
*
* @param b the buffer into which the data is read.
- * @param off the start offset in the destination array b
+ * @param off the start offset in the destination array {@code b}
* @param len the maximum number of bytes read.
* @return the total number of bytes read into the buffer, or
- * -1 if there is no more data because the end of
+ * {@code -1} if there is no more data because the end of
* the stream has been reached.
- * @exception NullPointerException If b is null.
- * @exception IndexOutOfBoundsException If off is negative,
- * len is negative, or len is greater than
- * b.length - off
+ * @throws NullPointerException If {@code b} is {@code null}.
+ * @throws IndexOutOfBoundsException If {@code off} is negative,
+ * {@code len} is negative, or {@code len} is greater than
+ * {@code b.length - off}
*/
+ @Override
public synchronized int read(byte b[], int off, int len) {
- if (b == null) {
- throw new NullPointerException();
- } else if (off < 0 || len < 0 || len > b.length - off) {
- throw new IndexOutOfBoundsException();
- }
+ Objects.checkFromIndexSize(off, len, b.length);
if (pos >= count) {
return -1;
@@ -196,18 +196,40 @@
return len;
}
+ @Override
+ public synchronized byte[] readAllBytes() {
+ byte[] result = Arrays.copyOfRange(buf, pos, count);
+ pos = count;
+ return result;
+ }
+
+ @Override
+ public int readNBytes(byte[] b, int off, int len) {
+ int n = read(b, off, len);
+ return n == -1 ? 0 : n;
+ }
+
+ @Override
+ public synchronized long transferTo(OutputStream out) throws IOException {
+ int len = count - pos;
+ out.write(buf, pos, len);
+ pos = count;
+ return len;
+ }
+
/**
- * Skips n bytes of input from this input stream. Fewer
+ * Skips {@code n} bytes of input from this input stream. Fewer
* bytes might be skipped if the end of the input stream is reached.
- * The actual number k
+ * The actual number {@code k}
* of bytes to be skipped is equal to the smaller
- * of n and count-pos.
- * The value k is added into pos
- * and k is returned.
+ * of {@code n} and {@code count-pos}.
+ * The value {@code k} is added into {@code pos}
+ * and {@code k} is returned.
*
* @param n the number of bytes to be skipped.
* @return the actual number of bytes skipped.
*/
+ @Override
public synchronized long skip(long n) {
long k = count - pos;
if (n < k) {
@@ -222,23 +244,25 @@
* Returns the number of remaining bytes that can be read (or skipped over)
* from this input stream.
*
- * The value returned is count - pos,
+ * The value returned is {@code count - pos},
* which is the number of bytes remaining to be read from the input buffer.
*
* @return the number of remaining bytes that can be read (or skipped
* over) from this input stream without blocking.
*/
+ @Override
public synchronized int available() {
return count - pos;
}
/**
- * Tests if this InputStream supports mark/reset. The
- * markSupported method of ByteArrayInputStream
- * always returns true.
+ * Tests if this {@code InputStream} supports mark/reset. The
+ * {@code markSupported} method of {@code ByteArrayInputStream}
+ * always returns {@code true}.
*
* @since 1.1
*/
+ @Override
public boolean markSupported() {
return true;
}
@@ -253,11 +277,12 @@
* offset passed to the constructor (or 0 if the offset was not
* supplied).
*
- *
Note: The readAheadLimit for this class
+ *
Note: The {@code readAheadLimit} for this class * has no meaning. * * @since 1.1 */ + @Override public void mark(int readAheadLimit) { mark = pos; } @@ -267,6 +292,7 @@ * is 0 unless another position was marked or an offset was specified * in the constructor. */ + @Override public synchronized void reset() { pos = mark; } @@ -276,6 +302,7 @@ * this class can be called after the stream has been closed without * generating an {@code IOException}. */ + @Override public void close() throws IOException { } --- /dev/null 2018-03-14 11:34:37.000000000 -0700 +++ new/test/jdk/java/io/ByteArrayInputStream/ReadAllReadNTransferTo.java 2018-03-14 11:34:37.000000000 -0700 @@ -0,0 +1,85 @@ +/* + * Copyright (c) 2018, 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.ByteArrayInputStream; +import java.io.ByteArrayOutputStream; +import java.io.IOException; +import java.util.Arrays; +import java.util.Objects; +import java.util.Random; +import jdk.test.lib.RandomFactory; + +/* @test + * @library /test/lib + * @build jdk.test.lib.RandomFactory + * @run main ReadAllReadNTransferTo + * @bug 8180451 + * @summary Verify ByteArrayInputStream readAllBytes, readNBytes, and transferTo + * @key randomness + */ +public class ReadAllReadNTransferTo { + private static final int SIZE = 0x4d4d; + + private static Random random = RandomFactory.getRandom(); + + public static void main(String... args) throws IOException { + byte[] buf = new byte[SIZE]; + random.nextBytes(buf); + int position = random.nextInt(SIZE/2); + int size = random.nextInt(SIZE - position); + + ByteArrayInputStream bais = + new ByteArrayInputStream(buf, position, size); + int off = random.nextInt(size/2); + int len = random.nextInt(size- off); + + byte[] bN = new byte[off + len]; + if (bais.readNBytes(bN, off, len) != len) { + throw new RuntimeException("readNBytes return value"); + } + if (!Arrays.equals(bN, off, off + len, + buf, position, position + len)) { + throw new RuntimeException("readNBytes content"); + } + + byte[] bAll = bais.readAllBytes(); + Objects.requireNonNull(bAll, "readAllBytes return value"); + if (bAll.length != size - len) { + throw new RuntimeException("readAllBytes return value length"); + } + if (!Arrays.equals(bAll, 0, bAll.length, + buf, position + len, position + len + bAll.length)) { + throw new RuntimeException("readAllBytes content"); + } + + // XXX transferTo() + bais = new ByteArrayInputStream(buf); + ByteArrayOutputStream baos = new ByteArrayOutputStream(buf.length); + if (bais.transferTo(baos) != buf.length) { + throw new RuntimeException("transferTo return value length"); + } + if (!Arrays.equals(buf, baos.toByteArray())) { + throw new RuntimeException("transferTo content"); + } + } +}