archive/jdk
1
0
Fork 0
mirror of https://github.com/openjdk/jdk.git synced 2025-08-27 06:45:07 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

8286783: Expand use of @inheritDoc in InputStream and OutputStream subclasses

Browse source 
Reviewed-by: alanb
This commit is contained in:
Joe Darcy 2022-05-17 16:14:28 +00:00
parent ea713c37fb
commit 8e602b862d
13 changed files with 156 additions and 141 deletions
Download patch file Download diff file Expand all files Collapse all files

33
src/java.base/share/classes/java/io/FileInputStream.java
View file

@ -228,8 +228,9 @@ public class FileInputStream extends InputStream
*
* @return the next byte of data, or {@code -1} if the end of the
* file is reached.
* @throws IOException if an I/O error occurs.
* @throws IOException {@inheritDoc}
*/
@Override
public int read() throws IOException {
long comp = Blocker.begin();
try {
@ -255,12 +256,13 @@ public class FileInputStream extends InputStream
* stream into an array of bytes. This method blocks until some input
* is available.
*
* @param b the buffer into which the data is read.
* @param b {@inheritDoc}
* @return the total number of bytes read into the buffer, or
* {@code -1} if there is no more data because the end of
* the file has been reached.
* @throws IOException if an I/O error occurs.
*/
@Override
public int read(byte[] b) throws IOException {
long comp = Blocker.begin();
try {
@ -276,18 +278,15 @@ public class FileInputStream extends InputStream
* blocks until some input is available; otherwise, no
* bytes are read and {@code 0} is returned.
*
* @param b the buffer into which the data is read.
* @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
* {@code -1} if there is no more data because the end of
* the file has been reached.
* @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}
* @param b {@inheritDoc}
* @param off {@inheritDoc}
* @param len {@inheritDoc}
* @return {@inheritDoc}
* @throws NullPointerException {@inheritDoc}
* @throws IndexOutOfBoundsException {@inheritDoc}
* @throws IOException if an I/O error occurs.
*/
@Override
public int read(byte[] b, int off, int len) throws IOException {
long comp = Blocker.begin();
try {
@ -297,6 +296,7 @@ public class FileInputStream extends InputStream
}
}
@Override
public byte[] readAllBytes() throws IOException {
long length = length();
long position = position();
@ -339,6 +339,7 @@ public class FileInputStream extends InputStream
return (capacity == nread) ? buf : Arrays.copyOf(buf, nread);
}
@Override
public byte[] readNBytes(int len) throws IOException {
if (len < 0)
throw new IllegalArgumentException("len < 0");
@ -378,6 +379,7 @@ public class FileInputStream extends InputStream
/**
* {@inheritDoc}
*/
@Override
public long transferTo(OutputStream out) throws IOException {
long transferred = 0L;
if (out instanceof FileOutputStream fos) {
@ -432,11 +434,12 @@ public class FileInputStream extends InputStream
* backing file. Attempting to read from the stream after skipping past
* the end will result in -1 indicating the end of the file.
*
* @param n the number of bytes to be skipped.
* @param n {@inheritDoc}
* @return the actual number of bytes skipped.
* @throws IOException if n is negative, if the stream does not
* support seek, or if an I/O error occurs.
*/
@Override
public long skip(long n) throws IOException {
long comp = Blocker.begin();
try {
@ -465,6 +468,7 @@ public class FileInputStream extends InputStream
* @throws IOException if this file input stream has been closed by calling
* {@code close} or an I/O error occurs.
*/
@Override
public int available() throws IOException {
long comp = Blocker.begin();
try {
@ -491,10 +495,11 @@ public class FileInputStream extends InputStream
* If cleanup of native resources is needed, other mechanisms such as
* {@linkplain java.lang.ref.Cleaner} should be used.
*
* @throws IOException if an I/O error occurs.
* @throws IOException {@inheritDoc}
*
* @revised 1.4
*/
@Override
public void close() throws IOException {
if (closed) {
return;