public abstract class FilterReader extends Reader
Abstract class for reading filtered character streams. The abstract class 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.
protected Reader in
The underlying character-input stream.
protected FilterReader(Reader in)
Creates a new filtered reader.
in
- a Reader object providing the underlying stream.NullPointerException
- if in
is null
public int read() throws IOException
Reads a single character.
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
Reads characters into a portion of an array.
read
in class Reader
cbuf
- Destination bufferoff
- Offset at which to start storing characterslen
- Maximum number of characters to readIOException
- If an I/O error occurspublic long skip(long n) throws IOException
Skips characters.
skip
in class Reader
n
- The number of characters to skipIOException
- If an I/O error occurspublic boolean ready() throws IOException
Tells whether this stream is ready to be read.
ready
in class Reader
IOException
- If an I/O error occurspublic boolean markSupported()
Tells whether this stream supports the mark() operation.
markSupported
in class Reader
public void mark(int readAheadLimit) throws IOException
Marks the present position in the stream.
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
Resets the stream.
reset
in class Reader
IOException
- If an I/O error occurspublic void close() throws IOException
Description copied from class: Reader
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.
close
in interface Closeable
close
in interface AutoCloseable
close
in class Reader
IOException
- If an I/O error occurs
© 1993–2017, 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.