# PushbackInputStream

public class **PushbackInputStream** extends [FilterInputStream](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/FilterInputStream.html)  
A `PushbackInputStream` adds
functionality to another input stream, namely
the ability to "push back" or "unread"
one byte. 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.

### Field Summary

|---|---|---|
| protected byte\[\] | [buf](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/PushbackInputStream.html#buf) | The pushback buffer. |
| protected int | [pos](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/PushbackInputStream.html#pos) | The position within the pushback buffer from which the next byte will be read. |

### Inherited Field Summary

From class [java.io.FilterInputStream](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/FilterInputStream.html)

|---|---|---|
| protected [InputStream](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html) | [in](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/FilterInputStream.html#in) | The input stream to be filtered. |

### Public Constructor Summary

|---|---|
|   | [PushbackInputStream](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/PushbackInputStream.html#PushbackInputStream(java.io.InputStream,%20int))([InputStream](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html) in, int size) Creates a `PushbackInputStream` with a pushback buffer of the specified `size`, and saves its argument, the input stream `in`, for later use. |
|   | [PushbackInputStream](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/PushbackInputStream.html#PushbackInputStream(java.io.InputStream))([InputStream](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html) in) Creates a `PushbackInputStream` and saves its argument, the input stream `in`, for later use. |

### Public Method Summary

|---|---|
| int | [available](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/PushbackInputStream.html#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. |
| synchronized void | [close](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/PushbackInputStream.html#close())() Closes this input stream and releases any system resources associated with the stream. |
| synchronized void | [mark](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/PushbackInputStream.html#mark(int))(int readlimit) Marks the current position in this input stream. |
| boolean | [markSupported](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/PushbackInputStream.html#markSupported())() Tests if this input stream supports the `mark` and `reset` methods, which it does not. |
| int | [read](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/PushbackInputStream.html#read())() Reads the next byte of data from this input stream. |
| int | [read](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/PushbackInputStream.html#read(byte[],%20int,%20int))(byte\[\] b, int off, int len) Reads up to `len` bytes of data from this input stream into an array of bytes. |
| synchronized void | [reset](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/PushbackInputStream.html#reset())() Repositions this stream to the position at the time the `mark` method was last called on this input stream. |
| long | [skip](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/PushbackInputStream.html#skip(long))(long n) Skips over and discards `n` bytes of data from this input stream. |
| void | [unread](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/PushbackInputStream.html#unread(byte[],%20int,%20int))(byte\[\] b, int off, int len) Pushes back a portion of an array of bytes by copying it to the front of the pushback buffer. |
| void | [unread](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/PushbackInputStream.html#unread(int))(int b) Pushes back a byte by copying it to the front of the pushback buffer. |
| void | [unread](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/PushbackInputStream.html#unread(byte[]))(byte\[\] b) Pushes back an array of bytes by copying it to the front of the pushback buffer. |

### Inherited Method Summary

From class [java.io.FilterInputStream](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/FilterInputStream.html)

|---|---|
| int | [available](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/FilterInputStream.html#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 caller of a method for this input stream. |
| void | [close](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/FilterInputStream.html#close())() Closes this input stream and releases any system resources associated with the stream. |
| synchronized void | [mark](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/FilterInputStream.html#mark(int))(int readlimit) Marks the current position in this input stream. |
| boolean | [markSupported](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/FilterInputStream.html#markSupported())() Tests if this input stream supports the `mark` and `reset` methods. |
| int | [read](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/FilterInputStream.html#read())() Reads the next byte of data from this input stream. |
| int | [read](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/FilterInputStream.html#read(byte[],%20int,%20int))(byte\[\] b, int off, int len) Reads up to `len` bytes of data from this input stream into an array of bytes. |
| int | [read](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/FilterInputStream.html#read(byte[]))(byte\[\] b) Reads up to `byte.length` bytes of data from this input stream into an array of bytes. |
| synchronized void | [reset](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/FilterInputStream.html#reset())() Repositions this stream to the position at the time the `mark` method was last called on this input stream. |
| long | [skip](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/FilterInputStream.html#skip(long))(long n) Skips over and discards `n` bytes of data from the input stream. |

From class [java.io.InputStream](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html)

|---|---|
| int | [available](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html#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](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html#close())() Closes this input stream and releases any system resources associated with the stream. |
| synchronized void | [mark](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html#mark(int))(int readlimit) Marks the current position in this input stream. |
| boolean | [markSupported](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html#markSupported())() Tests if this input stream supports the `mark` and `reset` methods. |
| abstract int | [read](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html#read())() Reads the next byte of data from the input stream. |
| int | [read](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html#read(byte[],%20int,%20int))(byte\[\] b, int off, int len) Reads up to `len` bytes of data from the input stream into an array of bytes. |
| int | [read](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html#read(byte[]))(byte\[\] b) Reads some number of bytes from the input stream and stores them into the buffer array `b`. |
| synchronized void | [reset](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html#reset())() Repositions this stream to the position at the time the `mark` method was last called on this input stream. |
| long | [skip](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html#skip(long))(long n) Skips over and discards `n` bytes of data from this input stream. |

From class [java.lang.Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html)

|---|---|
| [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) | [clone](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#clone())() Creates and returns a copy of this `Object`. |
| boolean | [equals](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#equals(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) obj) Compares this instance with the specified object and indicates if they are equal. |
| void | [finalize](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#finalize())() Invoked when the garbage collector has detected that this instance is no longer reachable. |
| final [Class](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html)\<?\> | [getClass](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#getClass())() Returns the unique instance of `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html` that represents this object's class. |
| int | [hashCode](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#hashCode())() Returns an integer hash code for this object. |
| final void | [notify](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#notify())() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up. |
| final void | [notifyAll](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#notifyAll())() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up. |
| [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [toString](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#toString())() Returns a string containing a concise, human-readable description of this object. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait(long,%20int))(long timeout, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait(long))(long timeout) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait())() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object. |

From interface [java.io.Closeable](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Closeable.html)

|---|---|
| abstract void | [close](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Closeable.html#close())() Closes this stream and releases any system resources associated with it. |

From interface [java.lang.AutoCloseable](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/AutoCloseable.html)

|---|---|
| abstract void | [close](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/AutoCloseable.html#close())() Closes this resource, relinquishing any underlying resources. |

## Fields

#### protected byte\[\]
**buf**

The pushback buffer.

#### protected int
**pos**

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
equal to zero.

## Public Constructors

#### public
**PushbackInputStream**
([InputStream](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html) in, int size)

Creates a `PushbackInputStream`
with a pushback buffer of the specified `size`,
and saves its argument, the input stream
`in`, for later use. Initially,
there is no pushed-back byte (the field
`pushBack` is initialized to
`-1`).

##### Parameters

| in | the input stream from which bytes will be read. |
| size | the size of the pushback buffer. |
|---|---|

##### Throws

| [IllegalArgumentException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IllegalArgumentException.html) | if `size <= 0` |
|---|---|

#### public
**PushbackInputStream**
([InputStream](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html) in)

Creates a `PushbackInputStream`
and saves its argument, the input stream
`in`, for later use. Initially,
there is no pushed-back byte (the field
`pushBack` is initialized to
`-1`).

##### Parameters

| in | the input stream from which bytes will be read. |
|---|---|

## Public Methods

#### public 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. The next invocation 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.

The method returns the sum of the number of bytes that have been
pushed back and the value returned by `https://developers.google.com/j2objc/javadoc/jre/reference/java/io/FilterInputStream.html#available()`.

##### Returns

- the number of bytes that can be read (or skipped over) from the input stream without blocking.

##### Throws

| [IOException](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/IOException.html) | if this input stream has been closed by invoking its `https://developers.google.com/j2objc/javadoc/jre/reference/java/io/PushbackInputStream.html#close()` method, or an I/O error occurs. |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/io/FilterInputStream.html#in`
- `https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html#available()`

#### public synchronized void
**close**
()

Closes this input stream and releases any system resources
associated with the stream.
Once the stream has been closed, further read(), unread(),
available(), reset(), or skip() invocations will throw an IOException.
Closing a previously closed stream has no effect.

##### Throws

| [IOException](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/IOException.html) | if an I/O error occurs. |
|---|---|

#### public synchronized void
**mark**
(int readlimit)

Marks the current position in this input stream.

The `mark` method of `PushbackInputStream`
does nothing.

##### Parameters

| readlimit | the maximum limit of bytes that can be read before the mark position becomes invalid. |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html#reset()`

#### public boolean
**markSupported**
()

Tests if this input stream supports the `mark` and
`reset` methods, which it does not.

##### Returns

- `false`, since this class does not support the `mark` and `reset` methods.

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html#mark(int)`
- `https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html#reset()`

#### public int
**read**
()

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
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.

##### Returns

- the next byte of data, or `-1` if the end of the stream has been reached.

##### Throws

| [IOException](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/IOException.html) | if this input stream has been closed by invoking its `https://developers.google.com/j2objc/javadoc/jre/reference/java/io/PushbackInputStream.html#close()` method, or an I/O error occurs. |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html#read()`

#### public int
**read**
(byte\[\] b, int off, int len)

Reads up to `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.

##### Parameters

| 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. |
|---|---|

##### Returns

- the total number of bytes read into the buffer, or `-1` if there is no more data because the end of the stream has been reached.

##### Throws

| [NullPointerException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/NullPointerException.html) | If `b` is `null`. |
| [IndexOutOfBoundsException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IndexOutOfBoundsException.html) | If `off` is negative, `len` is negative, or `len` is greater than `b.length - off` |
| [IOException](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/IOException.html) | if this input stream has been closed by invoking its `https://developers.google.com/j2objc/javadoc/jre/reference/java/io/PushbackInputStream.html#close()` method, or an I/O error occurs. |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html#read(byte[],%20int,%20int)`

#### public synchronized void
**reset**
()

Repositions this stream to the position at the time the
`mark` method was last called on this input stream.

The method `reset` for class
`PushbackInputStream` does nothing except throw an
`IOException`.

##### Throws

| [IOException](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/IOException.html) | if this method is invoked. |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html#mark(int)`
- `https://developers.google.com/j2objc/javadoc/jre/reference/java/io/IOException.html`

#### public long
**skip**
(long n)

Skips over and discards `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.

##### Parameters

| n |   |
|---|---|

##### Returns

- the actual number of bytes skipped.

##### Throws

| [IOException](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/IOException.html) | if the stream does not support seek, or the stream has been closed by invoking its `https://developers.google.com/j2objc/javadoc/jre/reference/java/io/PushbackInputStream.html#close()` method, or an I/O error occurs. |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/io/FilterInputStream.html#in`
- `https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html#skip(long)`

#### public void
**unread**
(byte\[\] b, int off, int len)

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.

##### Parameters

| b | the byte array to push back. |
| off | the start offset of the data. |
| len | the number of bytes to push back. |
|---|---|

##### Throws

| [IOException](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/IOException.html) | 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 `https://developers.google.com/j2objc/javadoc/jre/reference/java/io/PushbackInputStream.html#close()` method. |
|---|---|

#### public void
**unread**
(int b)

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`.

##### Parameters

| b | the `int` value whose low-order byte is to be pushed back. |
|---|---|

##### Throws

| [IOException](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/IOException.html) | If there is not enough room in the pushback buffer for the byte, or this input stream has been closed by invoking its `https://developers.google.com/j2objc/javadoc/jre/reference/java/io/PushbackInputStream.html#close()` method. |
|---|---|

#### public void
**unread**
(byte\[\] b)

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.

##### Parameters

| b | the byte array to push back |
|---|---|

##### Throws

| [IOException](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/IOException.html) | 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 `https://developers.google.com/j2objc/javadoc/jre/reference/java/io/PushbackInputStream.html#close()` method. |
|---|---|