Closeable, AutoCloseable, Readable
BufferedReader, CharArrayReader, FilterReader, InputStreamReader, PipedReader, StringReader
Abstract class for reading character streams. The only methods that a subclass must implement are read(char[], int, int) and close(). Most subclasses, however, will override some of the methods defined here in order to provide higher efficiency, additional functionality, or both.
Fields
The object used to synchronize operations on this stream.
Constructors
protected
Creates a new character-stream reader whose critical sections will synchronize on the reader itself.
protected
Creates a new character-stream reader whose critical sections will synchronize on the given object.
abstract void
Closes the stream and releases any system resources associated with it.
void
Marks the present position in the stream.
boolean
Tells whether this stream supports the mark() operation.
Returns a new Reader that reads no characters.
int
Reads a single character.
int
Reads characters into an array.
abstract int
read(char[] cbuf, int off, int len)
Reads characters into a portion of an array.
int
Attempts to read characters into the specified character buffer.
boolean
Tells whether this stream is ready to be read.
void
long
long
Reads all characters from this reader and writes the characters to the given writer in the order that they are read.
Methods declared in class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitThe object used to synchronize operations on this stream. For efficiency, a character-stream object may use an object other than itself to protect critical sections. A subclass should therefore use the object in this field rather than this or a synchronized method.
protected Reader()
Creates a new character-stream reader whose critical sections will synchronize on the reader itself.
Creates a new character-stream reader whose critical sections will synchronize on the given object.
lock - The Object to synchronize on.
()
Returns a new
Reader
that reads no characters. The returned stream is initially open. The stream is closed by calling the
close()
method. Subsequent calls to
close()
have no effect.
While the stream is open, the read(), read(char[]), read(char[], int, int), read(CharBuffer), ready(), skip(long), and transferTo() methods all behave as if end of stream has been reached. After the stream has been closed, these methods all throw IOException.
The markSupported() method returns false. The mark() and reset() methods throw an IOException.
The object used to synchronize operations on the returned Reader is not specified.
Reader which reads no characters
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.
read in interface Readable
target - the buffer to read characters into
IOException - if an I/O error occurs
NullPointerException - if target is null
ReadOnlyBufferException - if target is a read only buffer
Subclasses that intend to support efficient single-character input should override this method.
0x00-0xffff), or -1 if the end of the stream has been reached
IOException - If an I/O error occurs
If the length of cbuf 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.
cbuf - Destination buffer
IOException - If an I/O error occurs
throws
IOExceptionIf 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.
cbuf - Destination buffer
off - Offset at which to start storing characters
len - Maximum number of characters to read
IndexOutOfBoundsException - If off is negative, or len is negative, or len is greater than cbuf.length - off
IOException - If an I/O error occurs
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.
n - The number of characters to skip
IllegalArgumentException - If n is negative.
IOException - If an I/O error occurs
Tells whether this stream is ready to be read.
IOException - If an I/O error occurs
public boolean markSupported()
Tells whether this stream supports the mark() operation. The default implementation always returns false. Subclasses should override this method.
throws
IOExceptionMarks 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.
IOException - If the stream does not support mark(), or if some other I/O error occurs
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().
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
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 AutoCloseable
close in interface Closeable
IOException - If an I/O error occurs
Reads all characters from this reader and writes the characters to the given writer in the order that they are read. On return, this reader will be at end of the stream. This method does not close either reader or writer.
This method may block indefinitely reading from the reader, or writing to the writer. The behavior for the case where the reader and/or writer is asynchronously closed, or the thread interrupted during the transfer, is highly reader and writer specific, and therefore not specified.
If the total number of characters transferred is greater than Long.MAX_VALUE, then Long.MAX_VALUE will be returned.
If an I/O error occurs reading from the reader or writing to the writer, then it may do so after some characters have been read or written. Consequently the reader may not be at end of the stream and one, or both, streams may be in an inconsistent state. It is strongly recommended that both streams be promptly closed if an I/O error occurs.
out - the writer, non-null
IOException - if an I/O error occurs when reading or writing
NullPointerException - if out is null
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4