PushbackReader (Java 2 Platform SE 5.0) (original) (raw)

java.io

Class PushbackReader

java.lang.Object extended by java.io.Reader java.io.FilterReader java.io.PushbackReader

All Implemented Interfaces:

Closeable, Readable

public class PushbackReader

extends FilterReader

A character-stream reader that allows characters to be pushed back into the stream.

Since:

JDK1.1

Field Summary

Fields inherited from class java.io.FilterReader
in

Fields inherited from class java.io.Reader
lock

Constructor Summary
PushbackReader(Reader in) Create a new pushback reader with a one-character pushback buffer.
[PushbackReader](../../java/io/PushbackReader.html#PushbackReader%28java.io.Reader, int%29)(Reader in, int size) Create a new pushback reader with a pushback buffer of the given size.

Method Summary
void	close() Close the stream.
void	mark(int readAheadLimit) Mark the present position in the stream.
boolean	markSupported() Tell whether this stream supports the mark() operation, which it does not.
int	read() Read a single character.
int	[read](../../java/io/PushbackReader.html#read%28char[], int, int%29)(char[] cbuf, int off, int len) Read characters into a portion of an array.
boolean	ready() Tell whether this stream is ready to be read.
void	reset() Reset the stream.
long	skip(long n) Skip characters.
void	unread(char[] cbuf) Push back an array of characters by copying it to the front of the pushback buffer.
void	[unread](../../java/io/PushbackReader.html#unread%28char[], int, int%29)(char[] cbuf, int off, int len) Push back a portion of an array of characters by copying it to the front of the pushback buffer.
void	unread(int c) Push back a single character.

Methods inherited from class java.io.Reader
read, read

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, [wait](../../java/lang/Object.html#wait%28long, int%29)

Constructor Detail

PushbackReader

public PushbackReader(Reader in, int size)

Create 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](../../java/lang/IllegalArgumentException.html "class in java.lang") - if size is <= 0

PushbackReader

public PushbackReader(Reader in)

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

Parameters:

in - The reader from which characters will be read

Method Detail

read

public int read() throws IOException

Read a single character.

Overrides:

[read](../../java/io/FilterReader.html#read%28%29) in class [FilterReader](../../java/io/FilterReader.html "class in java.io")

Returns:

The character read, or -1 if the end of the stream has been reached

Throws:

[IOException](../../java/io/IOException.html "class in java.io") - If an I/O error occurs

read

public int read(char[] cbuf, int off, int len) throws IOException

Read characters into a portion of an array.

Overrides:

[read](../../java/io/FilterReader.html#read%28char[], int, int%29) in class [FilterReader](../../java/io/FilterReader.html "class in java.io")

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](../../java/io/IOException.html "class in java.io") - If an I/O error occurs

unread

public void unread(int c) throws IOException

Push back a single character.

Parameters:

c - The character to push back

Throws:

[IOException](../../java/io/IOException.html "class in java.io") - If the pushback buffer is full, or if some other I/O error occurs

unread

public void unread(char[] cbuf, int off, int len) throws IOException

Push 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](../../java/io/IOException.html "class in java.io") - If there is insufficient room in the pushback buffer, or if some other I/O error occurs

unread

public void unread(char[] cbuf) throws IOException

Push 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](../../java/io/IOException.html "class in java.io") - If there is insufficient room in the pushback buffer, or if some other I/O error occurs

ready

public boolean ready() throws IOException

Tell whether this stream is ready to be read.

Overrides:

[ready](../../java/io/FilterReader.html#ready%28%29) in class [FilterReader](../../java/io/FilterReader.html "class in java.io")

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](../../java/io/IOException.html "class in java.io") - If an I/O error occurs

mark

public void mark(int readAheadLimit) throws IOException

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

Overrides:

[mark](../../java/io/FilterReader.html#mark%28int%29) in class [FilterReader](../../java/io/FilterReader.html "class in java.io")

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](../../java/io/IOException.html "class in java.io") - Always, since mark is not supported

reset

public void reset() throws IOException

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

Overrides:

[reset](../../java/io/FilterReader.html#reset%28%29) in class [FilterReader](../../java/io/FilterReader.html "class in java.io")

Throws:

[IOException](../../java/io/IOException.html "class in java.io") - Always, since reset is not supported

markSupported

public boolean markSupported()

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

Overrides:

[markSupported](../../java/io/FilterReader.html#markSupported%28%29) in class [FilterReader](../../java/io/FilterReader.html "class in java.io")

Returns:

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

close

public void close() throws IOException

Close the stream.

Specified by:

[close](../../java/io/Closeable.html#close%28%29) in interface [Closeable](../../java/io/Closeable.html "interface in java.io")

Overrides:

[close](../../java/io/FilterReader.html#close%28%29) in class [FilterReader](../../java/io/FilterReader.html "class in java.io")

Throws:

[IOException](../../java/io/IOException.html "class in java.io") - If an I/O error occurs

skip

public long skip(long n) throws IOException

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

Overrides:

[skip](../../java/io/FilterReader.html#skip%28long%29) in class [FilterReader](../../java/io/FilterReader.html "class in java.io")

Parameters:

n - The number of characters to skip

Returns:

The number of characters actually skipped

Throws:

[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang") - If n is negative.

[IOException](../../java/io/IOException.html "class in java.io") - If an I/O error occurs

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.