- * This method - * simply performs {@code in.read()} and returns the result. + * + * @implSpec + * This method simply performs {@code in.read()} and returns the result. * * @return the next byte of data, or {@code -1} if the end of the * stream is reached. * @throws IOException if an I/O error occurs. * @see java.io.FilterInputStream#in */ + @Override public int read() throws IOException { return in.read(); } @@ -86,10 +83,11 @@ public int read() throws IOException { * Reads up to {@code b.length} bytes of data from this * input stream into an array of bytes. This method blocks until some * input is available. - *
+ * + * @implSpec * This method simply performs the call * {@code read(b, 0, b.length)} and returns - * the result. It is important that it does + * the result. It is important that it does * not do {@code in.read(b)} instead; * certain subclasses of {@code FilterInputStream} * depend on the implementation strategy actually @@ -102,6 +100,7 @@ public int read() throws IOException { * @throws IOException if an I/O error occurs. * @see java.io.FilterInputStream#read(byte[], int, int) */ + @Override public int read(byte[] b) throws IOException { return read(b, 0, b.length); } @@ -111,7 +110,8 @@ public int read(byte[] b) throws IOException { * into an array of bytes. If {@code len} is not zero, the method * blocks until some input is available; otherwise, no * bytes are read and {@code 0} is returned. - *
+ * + * @implSpec * This method simply performs {@code in.read(b, off, len)} * and returns the result. * @@ -128,6 +128,7 @@ public int read(byte[] b) throws IOException { * @throws IOException if an I/O error occurs. * @see java.io.FilterInputStream#in */ + @Override public int read(byte[] b, int off, int len) throws IOException { return in.read(b, off, len); } @@ -138,13 +139,15 @@ public int read(byte[] b, int off, int len) throws IOException { * reasons, end up skipping over some smaller number of bytes, * possibly {@code 0}. The actual number of bytes skipped is * returned. - *
- * This method simply performs {@code in.skip(n)}. + * + * @implSpec + * This method simply performs {@code in.skip(n)} and returns the result. * * @param n the number of bytes to be skipped. * @return the actual number of bytes skipped. * @throws IOException if {@code in.skip(n)} throws an IOException. */ + @Override public long skip(long n) throws IOException { return in.skip(n); } @@ -155,13 +158,15 @@ public long skip(long n) throws IOException { * caller of a method for this input stream. The next caller might be * the same thread or another thread. A single read or skip of this * many bytes will not block, but may read or skip fewer bytes. - *
- * This method returns the result of {@link #in in}.available(). * - * @return an estimate of the number of bytes that can be read (or skipped - * over) from this input stream without blocking. + * @implSpec + * This method returns the result of {@code in.available()}. + * + * @return an estimate of the number of bytes that can be read (or + * skipped over) from this input stream without blocking. * @throws IOException if an I/O error occurs. */ + @Override public int available() throws IOException { return in.available(); } @@ -169,12 +174,14 @@ public int available() throws IOException { /** * Closes this input stream and releases any system resources * associated with the stream. - * This - * method simply performs {@code in.close()}. + * + * @implSpec + * This method simply performs {@code in.close()}. * * @throws IOException if an I/O error occurs. * @see java.io.FilterInputStream#in */ + @Override public void close() throws IOException { in.close(); } @@ -187,7 +194,8 @@ public void close() throws IOException { * The {@code readlimit} argument tells this input stream to * allow that many bytes to be read before the mark position gets * invalidated. - *
+ * + * @implSpec * This method simply performs {@code in.mark(readlimit)}. * * @param readlimit the maximum limit of bytes that can be read before @@ -195,6 +203,7 @@ public void close() throws IOException { * @see java.io.FilterInputStream#in * @see java.io.FilterInputStream#reset() */ + @Override public synchronized void mark(int readlimit) { in.mark(readlimit); } @@ -203,9 +212,6 @@ public synchronized void mark(int readlimit) { * Repositions this stream to the position at the time the * {@code mark} method was last called on this input stream. *
- * This method - * simply performs {@code in.reset()}. - *
* Stream marks are intended to be used in * situations where you need to read ahead a little to see what's in * the stream. Often this is most easily done by invoking some @@ -215,11 +221,15 @@ public synchronized void mark(int readlimit) { * If this happens within readlimit bytes, it allows the outer * code to reset the stream and try another parser. * + * @implSpec + * This method simply performs {@code in.reset()}. + * * @throws IOException if the stream has not been marked or if the * mark has been invalidated. * @see java.io.FilterInputStream#in * @see java.io.FilterInputStream#mark(int) */ + @Override public synchronized void reset() throws IOException { in.reset(); } @@ -227,8 +237,9 @@ public synchronized void reset() throws IOException { /** * Tests if this input stream supports the {@code mark} * and {@code reset} methods. - * This method - * simply performs {@code in.markSupported()}. + * + * @implSpec + * This method simply performs {@code in.markSupported()}. * * @return {@code true} if this stream type supports the * {@code mark} and {@code reset} method; @@ -237,6 +248,7 @@ public synchronized void reset() throws IOException { * @see java.io.InputStream#mark(int) * @see java.io.InputStream#reset() */ + @Override public boolean markSupported() { return in.markSupported(); }