Closeable, AutoCloseable
public class PushbackInputStream extends FilterInputStream
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. This is useful in situations where it is convenient for a fragment of code to read an indefinite number of data bytes that are delimited by a particular byte value; after reading the terminating byte, the code fragment can "unread" it, so that the next read operation on the input stream will reread the byte that was pushed back. For example, bytes representing the characters constituting an identifier might be terminated by a byte representing an operator character; a method whose job is to read just an identifier can read until it sees the operator and then push the operator back to be re-read.| Modifier and Type | Field | Description |
|---|---|---|
protected byte[] |
buf |
The pushback buffer. |
protected int |
pos |
The position within the pushback buffer from which the next byte will be read. |
in
| Constructor | Description |
|---|---|
PushbackInputStream |
Creates a PushbackInputStream with a 1-byte pushback buffer, and saves its argument, the input stream in, for later use. |
PushbackInputStream |
Creates a PushbackInputStream with a pushback buffer of the specified size, and saves its argument, the input stream in, for later use. |
| Modifier and Type | Method | Description |
|---|---|---|
int |
available() |
Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking by the next invocation of a method for this input stream. |
void |
close() |
Closes this input stream and releases any system resources associated with the stream. |
void |
mark |
Marks the current position in this input stream. |
boolean |
markSupported() |
Tests if this input stream supports the mark and reset methods, which it does not. |
int |
read() |
Reads the next byte of data from this input stream. |
int |
read |
Reads up to len bytes of data from this input stream into an array of bytes. |
void |
reset() |
Repositions this stream to the position at the time the mark method was last called on this input stream. |
long |
skip |
Skips over and discards n bytes of data from this input stream. |
void |
unread |
Pushes back an array of bytes by copying it to the front of the pushback buffer. |
void |
unread |
Pushes back a portion of an array of bytes by copying it to the front of the pushback buffer. |
void |
unread |
Pushes back a byte by copying it to the front of the pushback buffer. |
read
nullInputStream, readAllBytes, readNBytes, readNBytes, skipNBytes, transferTo
protected byte[] buf
protected int pos
pos is equal to buf.length; when the buffer is full, pos is equal to zero.public PushbackInputStream(InputStream in, int size)
PushbackInputStream with a pushback buffer of the specified size, and saves its argument, the input stream in, for later use. Initially, the pushback buffer is empty.in - the input stream from which bytes will be read.size - the size of the pushback buffer.IllegalArgumentException - if size <= 0
public PushbackInputStream(InputStream in)
PushbackInputStream with a 1-byte pushback buffer, and saves its argument, the input stream in, for later use. Initially, the pushback buffer is empty.in - the input stream from which bytes will be read.public int read() throws IOException
int in the range 0 to 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 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 input stream and returns whatever value that method returns.
read in class FilterInputStream
-1 if the end of the stream has been reached.IOException - if this input stream has been closed by invoking its close() method, or an I/O error occurs.public int read(byte[] b, int off, int len) throws IOException
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 blocks until at least 1 byte of input is available; otherwise, no bytes are read and 0 is returned.read in class FilterInputStream
b - the buffer into which the data is read.off - the start offset in the destination array b
len - the maximum number of bytes read.-1 if there is no more data because the end of the stream has been reached.NullPointerException - If b is null.IndexOutOfBoundsException - If off is negative, len is negative, or len is greater than b.length - off
IOException - if this input stream has been closed by invoking its close() method, or an I/O error occurs.public void unread(int b) throws IOException
(byte)b.b - the int value whose low-order byte is to be pushed back.IOException - If there is not enough room in the pushback buffer for the byte, or this input stream has been closed by invoking its close() method.public void unread(byte[] b, int off, int len) throws IOException
b[off], the byte after that will have the value b[off+1], and so forth.b - the byte array to push back.off - the start offset of the data.len - the number of bytes to push back.NullPointerException - If b is null.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 close() method.public void unread(byte[] b) throws IOException
b[0], the byte after that will have the value b[1], and so forth.b - the byte array to push backNullPointerException - If b is null.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 close() method.public int available() throws IOException
The method returns the sum of the number of bytes that have been pushed back and the value returned by available.
available in class FilterInputStream
IOException - if this input stream has been closed by invoking its close() method, or an I/O error occurs.public long skip(long n) throws IOException
n bytes of data from this input stream. The 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. The skip method of PushbackInputStream first skips over the bytes in the pushback buffer, if any. It then calls the skip method of the underlying input stream if more bytes need to be skipped. The actual number of bytes skipped is returned.
skip in class FilterInputStream
n - the number of bytes to be skipped.IOException - if the stream has been closed by invoking its close() method, in.skip(n) throws an IOException, or an I/O error occurs.public boolean markSupported()
mark and reset methods, which it does not.markSupported in class FilterInputStream
false, since this class does not support the mark and reset methods.public void mark(int readlimit)
The mark method of PushbackInputStream does nothing.
mark in class FilterInputStream
readlimit - the maximum limit of bytes that can be read before the mark position becomes invalid.public void reset() throws IOException
mark method was last called on this input stream. The method reset for class PushbackInputStream does nothing except throw an IOException.
reset in class FilterInputStream
IOException - if this method is invoked.public void close() throws IOException
close in interface AutoCloseable
close in interface Closeable
close in class FilterInputStream
IOException - if an I/O error occurs.
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/PushbackInputStream.html