Closeable
, AutoCloseable
, Readable
PushbackReader
public abstract class FilterReader extends Reader
FilterReader
itself provides default methods that pass all requests to the contained stream. Subclasses of FilterReader
should override some of these methods and may also provide additional methods and fields.Modifier and Type | Field | Description |
---|---|---|
protected Reader |
in |
The underlying character-input stream. |
Modifier | Constructor | Description |
---|---|---|
protected |
Creates a new filtered reader. |
Modifier and Type | Method | Description |
---|---|---|
void |
close() |
Closes the stream and releases any system resources associated with it. |
void |
mark |
Marks the present position in the stream. |
boolean |
markSupported() |
Tells whether this stream supports the mark() operation. |
int |
read() |
Reads a single character. |
int |
read |
Reads characters into a portion of an array. |
boolean |
ready() |
Tells whether this stream is ready to be read. |
void |
reset() |
Resets the stream. |
long |
skip |
Skips characters. |
nullReader, read, read, transferTo
protected Reader in
protected FilterReader(Reader in)
in
- a Reader object providing the underlying stream.NullPointerException
- if in
is null
public int read() throws IOException
read
in class Reader
0x00-0xffff
), or -1 if the end of the stream has been reachedIOException
- If an I/O error occurspublic int read(char[] cbuf, int off, int len) throws IOException
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
.
read
in class Reader
cbuf
- Destination bufferoff
- Offset at which to start storing characterslen
- Maximum number of characters to readIndexOutOfBoundsException
- If off
is negative, or len
is negative, or len
is greater than cbuf.length - off
IOException
- If an I/O error occurspublic long skip(long n) throws IOException
skip
in class Reader
n
- The number of characters to skipIllegalArgumentException
- If n
is negative and the contained Reader
's skip
method throws an IllegalArgumentException for a negative parameterIOException
- If an I/O error occurspublic boolean ready() throws IOException
ready
in class Reader
IOException
- If an I/O error occurspublic boolean markSupported()
markSupported
in class Reader
public void mark(int readAheadLimit) throws IOException
mark
in class Reader
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.IOException
- If an I/O error occurspublic void reset() throws IOException
reset
in class Reader
IOException
- If an I/O error occurspublic void close() throws IOException
Reader
close
in interface AutoCloseable
close
in interface Closeable
close
in class Reader
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/FilterReader.html