| Methods |
| abstract public void |
close() throws IOException Details
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.
|
| public void |
mark(int readAheadLimit) throws IOException Details
Marks the present position in the stream. Subsequent calls to reset()
will attempt to reposition the stream to this point. Not all
character-input streams support the mark() operation.
| 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: If the stream does not support mark(),
or if some other I/O error occurs |
|
| public boolean |
markSupported() Details
Tells whether this stream supports the mark() operation. The default
implementation always returns false. Subclasses should override this
method.
| return | true if and only if this stream supports the mark operation. |
|
| public int |
read(java.nio.CharBuffer target) throws IOException Details
Attempts to read characters into the specified character buffer.
The buffer is used as a repository of characters as-is: the only
changes made are the results of a put operation. No flipping or
rewinding of the buffer is performed.
| target | the buffer to read characters into |
| return | The number of characters added to the buffer, or
-1 if this source of characters is at its end |
| Throws | IOException: if an I/O error occurs |
| Throws | NullPointerException: if target is null |
| Throws | ReadOnlyBufferException: if target is a read only buffer |
| since | 1.5 |
|
| public int |
read() throws IOException Details
Reads a single character. This method will block until a character is
available, an I/O error occurs, or the end of the stream is reached.
Subclasses that intend to support efficient single-character input
should override this method.
| return | 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 |
| Throws | IOException: If an I/O error occurs |
|
| public int |
read(char[] cbuf) throws IOException Details
Reads characters into an array. This method will block until some input
is available, an I/O error occurs, or the end of the stream is reached.
| cbuf | Destination buffer |
| return | The number of characters read, or -1
if the end of the stream
has been reached |
| Throws | IOException: If an I/O error occurs |
|
| abstract public int |
read(char[] cbuf, int off, int len) throws IOException Details
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.
| cbuf | Destination buffer |
| off | Offset at which to start storing characters |
| len | Maximum number of characters to read |
| return | The number of characters read, or -1 if the end of the
stream has been reached |
| Throws | IOException: If an I/O error occurs |
|
| public boolean |
ready() throws IOException Details
Tells whether this stream is ready to be read.
| return | 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: If an I/O error occurs |
|
| public void |
reset() throws IOException Details
Resets the stream. If the stream has been marked, then attempt to
reposition it at the mark. If the stream has not been marked, then
attempt to reset it in some way appropriate to the particular stream,
for example by repositioning it to its starting point. Not all
character-input streams support the reset() operation, and some support
reset() without supporting mark().
| Throws | IOException: If the stream has not been marked,
or if the mark has been invalidated,
or if the stream does not support reset(),
or if some other I/O error occurs |
|
| public long |
skip(long n) throws IOException Details
Skips characters. This method will block until some characters are
available, an I/O error occurs, or the end of the stream is reached.
|