Reader

Reader

protected Reader()

Creates a new character-stream reader whose critical sections will synchronize on the reader itself.

Reader

protected Reader(lock: Any!)

Creates a new character-stream reader whose critical sections will synchronize on the given object.

close

abstract fun close(): Unit

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.

mark

open fun mark(readAheadLimit: Int): Unit

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.

markSupported

open fun markSupported(): Boolean

Tells whether this stream supports the mark() operation. The default implementation always returns false. Subclasses should override this method.

nullReader

open static fun nullReader(): Reader!

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.

read

open fun read(target: CharBuffer!): Int

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

open fun read(): Int

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.

read

open fun read(cbuf: CharArray!): Int

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.

read

abstract fun read(
    cbuf: CharArray!, 
    off: Int, 
    len: Int
): Int

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.

ready

open fun ready(): Boolean

Tells whether this stream is ready to be read.

reset

open fun reset(): Unit

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().

skip

open fun skip(n: Long): Long

Skips characters. This method will block until some characters are available, an I/O error occurs, or the end of the stream is reached.

transferTo

open fun transferTo(out: Writer!): Long

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 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.

lock

protected var lock: Any!

The 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.