# PushbackReader

public class **PushbackReader** extends [FilterReader](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/FilterReader.html)  
A character-stream reader that allows characters to be pushed back into the
stream.

### Inherited Field Summary

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

|---|---|---|
| protected [Reader](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Reader.html) | [in](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/FilterReader.html#in) | The underlying character-input stream. |

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

|---|---|---|
| protected [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) | [lock](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Reader.html#lock) | The object used to synchronize operations on this stream. |

### Public Constructor Summary

|---|---|
|   | [PushbackReader](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/PushbackReader.html#PushbackReader(java.io.Reader,%20int))([Reader](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Reader.html) in, int size) Creates a new pushback reader with a pushback buffer of the given size. |
|   | [PushbackReader](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/PushbackReader.html#PushbackReader(java.io.Reader))([Reader](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Reader.html) in) Creates a new pushback reader with a one-character pushback buffer. |

### Public Method Summary

|---|---|
| void | [close](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/PushbackReader.html#close())() Closes the stream and releases any system resources associated with it. |
| void | [mark](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/PushbackReader.html#mark(int))(int readAheadLimit) Marks the present position in the stream. |
| boolean | [markSupported](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/PushbackReader.html#markSupported())() Tells whether this stream supports the mark() operation, which it does not. |
| int | [read](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/PushbackReader.html#read())() Reads a single character. |
| int | [read](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/PushbackReader.html#read(char[],%20int,%20int))(char\[\] cbuf, int off, int len) Reads characters into a portion of an array. |
| boolean | [ready](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/PushbackReader.html#ready())() Tells whether this stream is ready to be read. |
| void | [reset](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/PushbackReader.html#reset())() Resets the stream. |
| long | [skip](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/PushbackReader.html#skip(long))(long n) Skips characters. |
| void | [unread](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/PushbackReader.html#unread(char[],%20int,%20int))(char\[\] cbuf, int off, int len) Pushes back a portion of an array of characters by copying it to the front of the pushback buffer. |
| void | [unread](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/PushbackReader.html#unread(char[]))(char\[\] cbuf) Pushes back an array of characters by copying it to the front of the pushback buffer. |
| void | [unread](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/PushbackReader.html#unread(int))(int c) Pushes back a single character by copying it to the front of the pushback buffer. |

### Inherited Method Summary

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

|---|---|
| void | [close](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/FilterReader.html#close())() Closes the stream and releases any system resources associated with it. |
| void | [mark](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/FilterReader.html#mark(int))(int readAheadLimit) Marks the present position in the stream. |
| boolean | [markSupported](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/FilterReader.html#markSupported())() Tells whether this stream supports the mark() operation. |
| int | [read](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/FilterReader.html#read())() Reads a single character. |
| int | [read](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/FilterReader.html#read(char[],%20int,%20int))(char\[\] cbuf, int off, int len) Reads characters into a portion of an array. |
| boolean | [ready](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/FilterReader.html#ready())() Tells whether this stream is ready to be read. |
| void | [reset](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/FilterReader.html#reset())() Resets the stream. |
| long | [skip](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/FilterReader.html#skip(long))(long n) Skips characters. |

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

|---|---|
| abstract void | [close](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Reader.html#close())() Closes the stream and releases any system resources associated with it. |
| void | [mark](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Reader.html#mark(int))(int readAheadLimit) Marks the present position in the stream. |
| boolean | [markSupported](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Reader.html#markSupported())() Tells whether this stream supports the mark() operation. |
| int | [read](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Reader.html#read())() Reads a single character. |
| abstract int | [read](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Reader.html#read(char[],%20int,%20int))(char\[\] cbuf, int off, int len) Reads characters into a portion of an array. |
| int | [read](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Reader.html#read(char[]))(char\[\] cbuf) Reads characters into an array. |
| int | [read](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Reader.html#read(java.nio.CharBuffer))([CharBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/CharBuffer.html) target) Attempts to read characters into the specified character buffer. |
| boolean | [ready](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Reader.html#ready())() Tells whether this stream is ready to be read. |
| void | [reset](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Reader.html#reset())() Resets the stream. |
| long | [skip](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Reader.html#skip(long))(long n) Skips characters. |

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.lang.Readable](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Readable.html)

|---|---|
| abstract int | [read](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Readable.html#read(java.nio.CharBuffer))([CharBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/CharBuffer.html) cb) Attempts to read characters into the specified character buffer. |

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

## Public Constructors

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

Creates a new pushback reader with a pushback buffer of the given size.

##### Parameters

| in | The reader from which characters 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
**PushbackReader**
([Reader](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Reader.html) in)

Creates a new pushback reader with a one-character pushback buffer.

##### Parameters

| in | The reader from which characters will be read |
|---|---|

## Public Methods

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

Closes the stream and releases any system resources associated with
it. Once the stream has been closed, further read(),
unread(), ready(), 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 void
**mark**
(int readAheadLimit)

Marks the present position in the stream. The `mark`
for class `PushbackReader` always throws an exception.

##### Parameters

| readAheadLimit | Limit on the number of characters that may be read while still preserving the mark. After reading this many characters, attempting to reset the stream may fail. |
|---|---|

##### Throws

| [IOException](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/IOException.html) | Always, since mark is not supported |
|---|---|

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

Tells whether this stream supports the mark() operation, which it does
not.

##### Returns

- true if and only if this stream supports the mark operation.

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

Reads a single character.

##### Returns

- The character read, 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 an I/O error occurs |
|---|---|

#### public int
**read**
(char\[\] cbuf, int off, int len)

Reads characters into a portion of an array.

##### Parameters

| cbuf | Destination buffer |
| off | Offset at which to start writing characters |
| len | Maximum number of characters to read |
|---|---|

##### Returns

- The number of characters read, 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 an I/O error occurs |
|---|---|

#### public boolean
**ready**
()

Tells whether this stream is ready to be read.

##### Returns

- True if the next read() is guaranteed not to block for input, false otherwise. Note that returning false does not guarantee that the next read will block.

##### Throws

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

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

Resets the stream. The `reset` method of
`PushbackReader` always throws an exception.

##### Throws

| [IOException](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/IOException.html) | Always, since reset is not supported |
|---|---|

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

Skips characters. This method will block until some characters are
available, an I/O error occurs, or the end of the stream is reached.

##### Parameters

| n | The number of characters to skip |
|---|---|

##### Returns

- The number of characters actually skipped

##### Throws

| [IllegalArgumentException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IllegalArgumentException.html) | If `n` is negative. |
| [IOException](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/IOException.html) | If an I/O error occurs |
|---|---|

#### public void
**unread**
(char\[\] cbuf, int off, int len)

Pushes back a portion of an array of characters by copying it to the
front of the pushback buffer. After this method returns, the next
character to be read will have the value `cbuf[off]`, the
character after that will have the value `cbuf[off+1]`, and
so forth.

##### Parameters

| cbuf | Character array |
| off | Offset of first character to push back |
| len | Number of characters to push back |
|---|---|

##### Throws

| [IOException](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/IOException.html) | If there is insufficient room in the pushback buffer, or if some other I/O error occurs |
|---|---|

#### public void
**unread**
(char\[\] cbuf)

Pushes back an array of characters by copying it to the front of the
pushback buffer. After this method returns, the next character to be
read will have the value `cbuf[0]`, the character after that
will have the value `cbuf[1]`, and so forth.

##### Parameters

| cbuf | Character array to push back |
|---|---|

##### Throws

| [IOException](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/IOException.html) | If there is insufficient room in the pushback buffer, or if some other I/O error occurs |
|---|---|

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

Pushes back a single character by copying it to the front of the
pushback buffer. After this method returns, the next character to be read
will have the value `(char)c`.

##### Parameters

| c | The int value representing a character to be pushed back |
|---|---|

##### Throws

| [IOException](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/IOException.html) | If the pushback buffer is full, or if some other I/O error occurs |
|---|---|