OpenJDK 1.22 · java.io.FilterReader · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
protected Reader	in The underlying character-input stream.

Access	Constructor and Description
protected	FilterReader(Reader a Reader object providing the underlying stream. in) Creates a new filtered reader.

Method Summary

Modifier and Type	Method and Description
public void	close() Implements abstract java.io.Reader.close. Implements java.io.Closeable.close. Closes the stream and releases any system resources associated with it.
public void	mark(int 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. readAheadLimit) Overrides java.io.Reader.mark. Marks the present position in the stream.
public boolean	markSupported() Overrides java.io.Reader.markSupported. Tells whether this stream supports the mark() operation.
public int	read() Overrides java.io.Reader.read. Reads a single character.
public int	read(char[] Destination buffer cbuf, int Offset at which to start storing characters off, int Maximum number of characters to read len) Implements abstract java.io.Reader.read. Reads characters into a portion of an array.
public boolean	ready() Overrides java.io.Reader.ready. Tells whether this stream is ready to be read.
public void	reset() Overrides java.io.Reader.reset. Resets the stream.
public long	skip(long The number of characters to skip n) Overrides java.io.Reader.skip. Skips characters.

Inherited from java.io.Reader:: nullReader read read transferTo

in	back to summary
protected Reader in The underlying character-input stream.

FilterReader	back to summary
protected FilterReader(Reader in) Creates a new filtered reader. Parameters in:Reader a Reader object providing the underlying stream. Exceptions NullPointerException: if `in` is `null`

Method Detail

close	back to summary
public void close() throws IOException Implements abstract java.io.Reader.close. Implements java.io.Closeable.close. Doc from java.io.Reader.close. Closes the stream and releases any system resources associated with it. Once the stream has been closed, further read(), ready(), mark(), reset(), or skip() invocations will throw an IOException. Closing a previously closed stream has no effect. Exceptions IOException: If an I/O error occurs

back to summary

public void close() throws IOException

Implements abstract java.io.Reader.close.

Implements java.io.Closeable.close.

Doc from java.io.Reader.close.

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

Exceptions

IOException:: If an I/O error occurs

mark	back to summary
public void mark(int readAheadLimit) throws IOException Overrides java.io.Reader.mark. Marks the present position in the stream. Parameters readAheadLimit:int Doc from java.io.Reader.mark. 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. Exceptions IOException: If an I/O error occurs

mark

back to summary

public void mark(int readAheadLimit) throws IOException

Overrides java.io.Reader.mark.

Marks the present position in the stream.

Parameters

readAheadLimit:int

Doc from java.io.Reader.mark.

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.

Exceptions

IOException:: If an I/O error occurs

markSupported	back to summary
public boolean markSupported() Overrides java.io.Reader.markSupported. Tells whether this stream supports the mark() operation. Returns:boolean Doc from java.io.Reader.markSupported. true if and only if this stream supports the mark operation.

markSupported

back to summary

public boolean markSupported()

Overrides java.io.Reader.markSupported.

Tells whether this stream supports the mark() operation.

Returns:boolean

Doc from java.io.Reader.markSupported.

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

read back to summary

read	back to summary
public int read() throws IOException Overrides java.io.Reader.read. Reads a single character. Returns:int Doc from java.io.Reader.read. The character read, as an integer in the range 0 to 65535 (`0x00-0xffff`), or -1 if the end of the stream has been reached Exceptions IOException: If an I/O error occurs

public int read() throws IOException

Overrides java.io.Reader.read.

Reads a single character.

Returns:int

Doc from java.io.Reader.read.

The character read, as an integer in the range 0 to 65535 (0x00-0xffff), or -1 if the end of the stream has been reached

Exceptions

IOException:: If an I/O error occurs

read back to summary

read	back to summary
public int read(char[] cbuf, int off, int len) throws IOException Implements abstract java.io.Reader.read. Doc from java.io.Reader.read. Reads characters into a portion of an array. This method will block until some input is available, an I/O error occurs, or the end of the stream is reached. If `len` is zero, then no characters are read and `0` is returned; otherwise, there is an attempt to read at least one character. If no character is available because the stream is at its end, the value `-1` is returned; otherwise, at least one character is read and stored into `cbuf`. Parameters cbuf:char[] Destination buffer off:int Offset at which to start storing characters len:int Maximum number of characters to read Returns:int The number of characters read, or -1 if the end of the stream has been reached Exceptions IOException: If an I/O error occurs IndexOutOfBoundsException: If `off` is negative, or `len` is negative, or `len` is greater than `cbuf.length - off`

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

Implements abstract java.io.Reader.read.

Doc from java.io.Reader.read.

Reads characters into a portion of an array. This method will block until some input is available, an I/O error occurs, or the end of the stream is reached.

If len is zero, then no characters are read and 0 is returned; otherwise, there is an attempt to read at least one character. If no character is available because the stream is at its end, the value -1 is returned; otherwise, at least one character is read and stored into cbuf.

Parameters

cbuf:char[]: Destination buffer
off:int: Offset at which to start storing characters
len:int: Maximum number of characters to read

Returns:int

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

Exceptions

IOException:: If an I/O error occurs
IndexOutOfBoundsException:: If off is negative, or len is negative, or len is greater than cbuf.length - off

ready	back to summary
public boolean ready() throws IOException Overrides java.io.Reader.ready. Tells whether this stream is ready to be read. Returns:boolean Doc from java.io.Reader.ready. 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. Exceptions IOException: If an I/O error occurs

ready

back to summary

public boolean ready() throws IOException

Overrides java.io.Reader.ready.

Tells whether this stream is ready to be read.

Returns:boolean

Doc from java.io.Reader.ready.

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.

Exceptions

IOException:: If an I/O error occurs

reset	back to summary
public void reset() throws IOException Overrides java.io.Reader.reset. Resets the stream. Exceptions IOException: If an I/O error occurs

reset

back to summary

public void reset() throws IOException

Overrides java.io.Reader.reset.

Resets the stream.

Exceptions

IOException:: If an I/O error occurs

skip back to summary

skip	back to summary
public long skip(long n) throws IOException Overrides java.io.Reader.skip. Doc from java.io.Reader.skip. Skips characters. This method will block until some characters are available, an I/O error occurs, or the end of the stream is reached. If the stream is already at its end before this method is invoked, then no characters are skipped and zero is returned. Parameters n:long The number of characters to skip Returns:long The number of characters actually skipped Exceptions IOException: If an I/O error occurs IllegalArgumentException: If `n` is negative and the contained `Reader`'s `skip` method throws an IllegalArgumentException for a negative parameter

public long skip(long n) throws IOException

Overrides java.io.Reader.skip.

Doc from java.io.Reader.skip.

Skips characters. This method will block until some characters are available, an I/O error occurs, or the end of the stream is reached. If the stream is already at its end before this method is invoked, then no characters are skipped and zero is returned.

Parameters

n:long: The number of characters to skip

Returns:long

The number of characters actually skipped

Exceptions

IOException:: If an I/O error occurs
IllegalArgumentException:: If n is negative and the contained Reader's skip method throws an IllegalArgumentException for a negative parameter

public abstract Class FilterReader

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail