PushbackInputStream adds
+ * A {@code PushbackInputStream} adds
* functionality to another input stream, namely
* the ability to "push back" or "unread" bytes,
* by storing pushed-back bytes in an internal buffer.
@@ -59,8 +59,8 @@
/**
* The position within the pushback buffer from which the next byte will
- * be read. When the buffer is empty, pos is equal to
- * buf.length; when the buffer is full, pos is
+ * be read. When the buffer is empty, {@code pos} is equal to
+ * {@code buf.length}; when the buffer is full, {@code pos} is
* equal to zero.
*
* @since 1.1
@@ -76,15 +76,15 @@
}
/**
- * Creates a PushbackInputStream
- * with a pushback buffer of the specified size,
+ * Creates a {@code PushbackInputStream}
+ * with a pushback buffer of the specified {@code size},
* and saves its argument, the input stream
- * in, for later use. Initially,
+ * {@code in}, for later use. Initially,
* the pushback buffer is empty.
*
* @param in the input stream from which bytes will be read.
* @param size the size of the pushback buffer.
- * @exception IllegalArgumentException if {@code size <= 0}
+ * @throws IllegalArgumentException if {@code size <= 0}
* @since 1.1
*/
public PushbackInputStream(InputStream in, int size) {
@@ -97,9 +97,9 @@
}
/**
- * Creates a PushbackInputStream
+ * Creates a {@code PushbackInputStream}
* with a 1-byte pushback buffer, and saves its argument, the input stream
- * in, for later use. Initially,
+ * {@code in}, for later use. Initially,
* the pushback buffer is empty.
*
* @param in the input stream from which bytes will be read.
@@ -110,20 +110,20 @@
/**
* 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. This method blocks until input data
+ * {@code -1} is returned. This method blocks until input data
* is available, the end of the stream is detected, or an exception
* is thrown.
*
* This method returns the most recently pushed-back byte, if there is
- * one, and otherwise calls the read method of its underlying
+ * one, and otherwise calls the {@code read} method of its underlying
* input stream and returns whatever value that method returns.
*
- * @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.
- * @exception IOException if this input stream has been closed by
+ * @throws IOException if this input stream has been closed by
* invoking its {@link #close()} method,
* or an I/O error occurs.
* @see java.io.InputStream#read()
@@ -137,24 +137,24 @@
}
/**
- * Reads up to len bytes of data from this input stream into
+ * Reads up to {@code len} bytes of data from this input stream into
* an array of bytes. This method first reads any pushed-back bytes; after
- * that, if fewer than len bytes have been read then it
- * reads from the underlying input stream. If len is not zero, the method
+ * that, if fewer than {@code len} bytes have been read then it
+ * reads from the underlying input stream. If {@code len} is not zero, the method
* blocks until at least 1 byte of input is available; otherwise, no
- * bytes are read and 0 is returned.
+ * 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 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
- * @exception IOException if this input stream has been closed by
+ * @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}
+ * @throws IOException if this input stream has been closed by
* invoking its {@link #close()} method,
* or an I/O error occurs.
* @see java.io.InputStream#read(byte[], int, int)
@@ -192,11 +192,11 @@
/**
* Pushes back a byte by copying it to the front of the pushback buffer.
* After this method returns, the next byte to be read will have the value
- * (byte)b.
+ * {@code (byte)b}.
*
- * @param b the int value whose low-order
+ * @param b the {@code int} value whose low-order
* byte is to be pushed back.
- * @exception IOException If there is not enough room in the pushback
+ * @throws IOException If there is not enough room in the pushback
* buffer for the byte, or this input stream has been closed by
* invoking its {@link #close()} method.
*/
@@ -211,16 +211,17 @@
/**
* Pushes back a portion of an array of bytes by copying it to the front
* of the pushback buffer. After this method returns, the next byte to be
- * read will have the value b[off], the byte after that will
- * have the value b[off+1], and so forth.
+ * read will have the value {@code b[off]}, the byte after that will
+ * have the value {@code b[off+1]}, and so forth.
*
* @param b the byte array to push back.
* @param off the start offset of the data.
* @param len the number of bytes to push back.
- * @exception IOException If there is not enough room in the pushback
- * buffer for the specified number of bytes,
- * or this input stream has been closed by
- * invoking its {@link #close()} method.
+ * @throws NullPointerException If {@code b} is {@code null}.
+ * @throws IOException If there is not enough room in the pushback
+ * buffer for the specified number of bytes,
+ * or this input stream has been closed by
+ * invoking its {@link #close()} method.
* @since 1.1
*/
public void unread(byte[] b, int off, int len) throws IOException {
@@ -235,14 +236,15 @@
/**
* Pushes back an array of bytes by copying it to the front of the
* pushback buffer. After this method returns, the next byte to be read
- * will have the value b[0], the byte after that will have the
- * value b[1], and so forth.
+ * will have the value {@code b[0]}, the byte after that will have the
+ * value {@code b[1]}, and so forth.
*
* @param b the byte array to push back
- * @exception IOException If there is not enough room in the pushback
- * buffer for the specified number of bytes,
- * or this input stream has been closed by
- * invoking its {@link #close()} method.
+ * @throws NullPointerException If {@code b} is {@code null}.
+ * @throws IOException If there is not enough room in the pushback
+ * buffer for the specified number of bytes,
+ * or this input stream has been closed by
+ * invoking its {@link #close()} method.
* @since 1.1
*/
public void unread(byte[] b) throws IOException {
@@ -262,7 +264,7 @@
*
* @return the number of bytes that can be read (or skipped over) from
* the input stream without blocking.
- * @exception IOException if this input stream has been closed by
+ * @throws IOException if this input stream has been closed by
* invoking its {@link #close()} method,
* or an I/O error occurs.
* @see java.io.FilterInputStream#in
@@ -278,14 +280,14 @@
}
/**
- * Skips over and discards n bytes of data from this
- * input stream. The skip method may, for a variety of
+ * Skips over and discards {@code n} bytes of data from this
+ * input stream. The {@code skip} method may, for a variety of
* reasons, end up skipping over some smaller number of bytes,
- * possibly zero. If n is negative, no bytes are skipped.
+ * possibly zero. If {@code n} is negative, no bytes are skipped.
*
- *
The skip method of PushbackInputStream
+ *
The {@code skip} method of {@code PushbackInputStream}
* first skips over the bytes in the pushback buffer, if any. It then
- * calls the skip method of the underlying input stream if
+ * calls the {@code skip} method of the underlying input stream if
* more bytes need to be skipped. The actual number of bytes skipped
* is returned.
*
@@ -320,11 +322,11 @@
}
/**
- * Tests if this input stream supports the mark and
- * reset methods, which it does not.
+ * Tests if this input stream supports the {@code mark} and
+ * {@code reset} methods, which it does not.
*
- * @return false, since this class does not support the
- * mark and reset methods.
+ * @return {@code false}, since this class does not support the
+ * {@code mark} and {@code reset} methods.
* @see java.io.InputStream#mark(int)
* @see java.io.InputStream#reset()
*/
@@ -335,7 +337,7 @@
/**
* Marks the current position in this input stream.
*
- *
The mark method of PushbackInputStream
+ *
The {@code mark} method of {@code PushbackInputStream}
* does nothing.
*
* @param readlimit the maximum limit of bytes that can be read before
@@ -347,13 +349,13 @@
/**
* Repositions this stream to the position at the time the
- * mark method was last called on this input stream.
+ * {@code mark} method was last called on this input stream.
*
- *
The method reset for class
- * PushbackInputStream does nothing except throw an
- * IOException.
+ *
The method {@code reset} for class + * {@code PushbackInputStream} does nothing except throw an + * {@code IOException}. * - * @exception IOException if this method is invoked. + * @throws IOException if this method is invoked. * @see java.io.InputStream#mark(int) * @see java.io.IOException */ @@ -368,7 +370,7 @@ * available(), reset(), or skip() invocations will throw an IOException. * Closing a previously closed stream has no effect. * - * @exception IOException if an I/O error occurs. + * @throws IOException if an I/O error occurs. */ public synchronized void close() throws IOException { if (in == null)