|
| |
|
| java.lang.Object
 java.io.Reader
java.io.FilterReader
All known Subclasses: java.io.PushbackReader,
| FilterReader | | abstract public class FilterReader extends Reader (Code) | | FilterReader is a class which takes a Reader and filters the input
in some way. The filtered view may be a buffered view or one which
uncompresses data before returning characters read.
See Also: FilterWriter |
| Field Summary | |
| protected Reader | in
The target Reader which is being filtered. |
| Constructor Summary | |
| protected | FilterReader(Reader in)
Constructs a new FilterReader on the Reader in. |
| Method Summary | |
| public void | close()
Close this FilterReader. | | public synchronized void | mark(int readlimit)
Set a Mark position in this FilterReader. | | public boolean | markSupported()
Answers a boolean indicating whether or not this FilterReader supports
mark() and reset(). | | public int | read()
Reads a single char from this FilterReader and returns the result as an
int. | | public int | read(char[] buffer, int offset, int count)
Reads at most count chars from this FilterReader and
stores them in char array buffer starting at offset
offset. | | public boolean | ready()
Answers a boolean indicating whether or not this Reader is
ready to be read without blocking. | | public void | reset()
Reset this Readers position to the last mark() location.
Invocations of read()/skip() will occur from this new
location. | | public long | skip(long count)
Skips count number of characters in this Reader.
Subsequent read()'s will not return these characters
unless reset() is used. |
| in | | protected Reader in(Code) | | The target Reader which is being filtered.
|
| FilterReader | | protected FilterReader(Reader in)(Code) | | Constructs a new FilterReader on the Reader in. All reads
are now filtered through this Reader.
Parameters:
in - The non-null Reader to filter reads on. |
| close | | public void close() throws IOException(Code) | | Close this FilterReader. This implementation closes the target Reader.
throws:
IOException - If an error occurs attempting to close this Reader. |
| mark | | public synchronized void mark(int readlimit) throws IOException(Code) | | Set a Mark position in this FilterReader. The parameter
readLimit indicates how many characters can be read before
a mark is invalidated. Sending reset() will reposition the Reader back to
the marked position provided readLimit has not been
surpassed.
This implementation sets a mark in the target Reader.
Parameters:
readlimit - the number of characters to be able to read beforeinvalidating the mark.
throws:
IOException - If an error occurs attempting mark this Reader. |
| markSupported | | public boolean markSupported()(Code) | | Answers a boolean indicating whether or not this FilterReader supports
mark() and reset(). This implementation answers whether or not the target
Reader supports marking.
indicates whether or not mark() and reset() are supported. |
| read | | public int read() throws IOException(Code) | | Reads a single char from this FilterReader and returns the result as an
int. The 2 lowest order bytes are returned or -1 of the end of reader was
encountered. This implementation returns a char from the target Reader.
The byte read or -1 if end of reader.
throws:
IOException - If an error occurs attempting to read from this Reader. |
| read | | public int read(char[] buffer, int offset, int count) throws IOException(Code) | | Reads at most count chars from this FilterReader and
stores them in char array buffer starting at offset
offset. Answer the number of chars actually read or -1 if
no chars were read and end of reader was encountered. This implementation
reads chars from the target reader.
Parameters:
buffer - the char array in which to store the read chars.
Parameters:
offset - the offset in buffer to store the read chars.
Parameters:
count - the maximum number of chars to store in buffer. the number of chars actually read or -1 if end of reader.
throws:
IOException - If an error occurs attempting to read from this Reader. |
| ready | | public boolean ready() throws IOException(Code) | | Answers a boolean indicating whether or not this Reader is
ready to be read without blocking. If the result is true,
the next read() will not block. If the result is
false this Reader may or may not block when
read() is sent.
true if the receiver will not block whenread() is called, false if unknownor blocking will occur.
throws:
IOException - If the Reader is already closed or some other IO erroroccurs. |
| reset | | public void reset() throws IOException(Code) | | Reset this Readers position to the last mark() location.
Invocations of read()/skip() will occur from this new
location. If this Reader was not marked, the implementation of
reset() is implementation specific. See the comment for
the specific Reader subclass for implementation details. The default
action is to throw IOException.
throws:
IOException - if a problem occurred or the target Reader does not supportmark()/reset(). |
| skip | | public long skip(long count) throws IOException(Code) | | Skips count number of characters in this Reader.
Subsequent read()'s will not return these characters
unless reset() is used. The default implementation is to
skip chars in the filtered Reader.
Parameters:
count - the maximum number of characters to skip. the number of characters actually skipped.
throws:
IOException - If the Reader is already closed or some other IO erroroccurs. |
|
|
|