FileReader
open class FileReader : InputStreamReader
Reads text from character files using a default buffer size. Decoding from bytes to characters uses either a specified charset or the platform's default charset.
The FileReader is meant for reading streams of characters. For reading streams of raw bytes, consider using a FileInputStream.
Summary
| Public constructors |
|
Creates a new FileReader, given the name of the file to read, using the platform's default charset.
|
|
Creates a new FileReader, given the File to read, using the platform's default charset.
|
|
Creates a new FileReader, given the FileDescriptor to read, using the platform's default charset.
|
|
Creates a new FileReader, given the name of the file to read and the charset.
|
|
Creates a new FileReader, given the File to read and the charset.
|
| Inherited functions |
From class InputStreamReader
Unit |
close()
|
String! |
getEncoding()
Returns the name of the character encoding being used by this stream.
If the encoding has an historical name then that name is returned; otherwise the encoding's canonical name is returned.
If this instance was created with the InputStreamReader(java.io.InputStream,java.lang.String) constructor then the returned name, being unique for the encoding, may differ from the name passed to the constructor. This method will return null if the stream has been closed.
|
Int |
read(target: CharBuffer!)
|
Int |
read()
Reads a single character.
|
Int |
read(cbuf: CharArray!, off: Int, len: 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.
|
Boolean |
ready()
Tells whether this stream is ready to be read. An InputStreamReader is ready if its input buffer is not empty, or if bytes are available to be read from the underlying byte stream.
|
|
From class Reader
Unit |
mark(readAheadLimit: Int)
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.
|
Boolean |
markSupported()
Tells whether this stream supports the mark() operation. The default implementation always returns false. Subclasses should override this method.
|
Reader! |
nullReader()
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.
|
Int |
read(cbuf: CharArray!)
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.
|
Unit |
reset()
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().
|
Long |
skip(n: 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.
|
Long |
transferTo(out: Writer!)
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.
|
|
| Inherited properties |
From class Reader
Any! |
lock
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.
|
|
Public constructors
FileReader
FileReader(fileName: String!)
Creates a new FileReader, given the name of the file to read, using the platform's default charset.
| Parameters |
fileName |
String!: the name of the file to read |
| Exceptions |
java.io.FileNotFoundException |
if the named file does not exist, is a directory rather than a regular file, or for some other reason cannot be opened for reading. |
FileReader
FileReader(file: File!)
Creates a new FileReader, given the File to read, using the platform's default charset.
| Parameters |
file |
File!: the File to read |
| Exceptions |
java.io.FileNotFoundException |
if the file does not exist, is a directory rather than a regular file, or for some other reason cannot be opened for reading. |
FileReader
FileReader(
fileName: String!,
charset: Charset!)
Creates a new FileReader, given the name of the file to read and the charset.
| Exceptions |
java.io.IOException |
if the named file does not exist, is a directory rather than a regular file, or for some other reason cannot be opened for reading. |
FileReader
FileReader(
file: File!,
charset: Charset!)
Creates a new FileReader, given the File to read and the charset.
| Exceptions |
java.io.IOException |
if the file does not exist, is a directory rather than a regular file, or for some other reason cannot be opened for reading. |
