FileWriter  |  API reference  |  Android Developers (original) (raw)

open class FileWriter : OutputStreamWriter

kotlin.Any
↳ java.io.Writer
↳ java.io.OutputStreamWriter
↳

Writes text to character files using a default buffer size. Encoding from characters to bytes uses either a specified charset or the platform's default charset.

Whether or not a file is available or may be created depends upon the underlying platform. Some platforms, in particular, allow a file to be opened for writing by only one FileWriter (or other file-writing object) at a time. In such situations the constructors in this class will fail if the file involved is already open.

The FileWriter is meant for writing streams of characters. For writing streams of raw bytes, consider using a FileOutputStream.

Summary

Public constructors
FileWriter(file: File!) Constructs a FileWriter given the File to write, using the platform's default charset
FileWriter(file: File!, append: Boolean) Constructs a FileWriter given the File to write and a boolean indicating whether to append the data written, using the platform's default charset.
FileWriter(file: File!, charset: Charset!) Constructs a FileWriter given the File to write and charset.
FileWriter(file: File!, charset: Charset!, append: Boolean) Constructs a FileWriter given the File to write, charset and a boolean indicating whether to append the data written.
FileWriter(fd: FileDescriptor!) Constructs a FileWriter given a file descriptor, using the platform's default charset.
FileWriter(fileName: String!) Constructs a FileWriter given a file name, using the platform's default charset
FileWriter(fileName: String!, append: Boolean) Constructs a FileWriter given a file name and a boolean indicating whether to append the data written, using the platform's default charset.
FileWriter(fileName: String!, charset: Charset!) Constructs a FileWriter given a file name and charset.
FileWriter(fileName: String!, charset: Charset!, append: Boolean) Constructs a FileWriter given a file name, charset and a boolean indicating whether to append the data written.
Inherited functions
From class OutputStreamWriter Writer append(csq: CharSequence?) Writer append(csq: CharSequence?, start: Int, end: Int) Unit close() Unit flush() Flushes the stream. 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 OutputStreamWriter(java.io.OutputStream,java.lang.String) constructor then the returned name, being unique for the encoding, may differ from the name passed to the constructor. This method may return null if the stream has been closed. Unit write(cbuf: CharArray!, off: Int, len: Int) Writes a portion of an array of characters. Unit write(c: Int) Writes a single character. Unit write(str: String!, off: Int, len: Int) Writes a portion of a string.
From class Writer Writer append(c: Char) Appends the specified character to this writer. An invocation of this method of the form out.append(c) behaves in exactly the same way as the invocation out.write(c) Writer! nullWriter() Returns a new Writer which discards all 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 append(char), append(CharSequence), append(CharSequence, int, int), flush(), write(int), write(char[]), and write(char[], int, int) methods do nothing. After the stream has been closed, these methods all throw IOException. The object used to synchronize operations on the returned Writer is not specified. Unit write(cbuf: CharArray!) Writes an array of characters. Unit write(str: String!) Writes a string.
Inherited properties
From class Writer 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

FileWriter

FileWriter(file: File!)

Constructs a FileWriter given the File to write, using the platform's default charset

Parameters
file File!: the File to write.
Exceptions
java.io.IOException if the file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason

FileWriter

FileWriter(
    file: File!,
    append: Boolean)

Constructs a FileWriter given the File to write and a boolean indicating whether to append the data written, using the platform's default charset.

Parameters
file File!: the File to write
append Boolean: if true, then bytes will be written to the end of the file rather than the beginning
Exceptions
java.io.IOException if the file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason

FileWriter

FileWriter(
    file: File!,
    charset: Charset!)

Constructs a FileWriter given the File to write and charset.

Parameters
file File!: the File to write
charset Charset!: the charset
Exceptions
java.io.IOException if the file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason

FileWriter

FileWriter(
    file: File!,
    charset: Charset!,
    append: Boolean)

Constructs a FileWriter given the File to write, charset and a boolean indicating whether to append the data written.

Parameters
file File!: the File to write
charset Charset!: the charset
append Boolean: a boolean. If true, the writer will write the data to the end of the file rather than the beginning.
Exceptions
java.io.IOException if the file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason

FileWriter

FileWriter(fileName: String!)

Constructs a FileWriter given a file name, using the platform's default charset

Parameters
fileName String!: String The system-dependent filename.
Exceptions
java.io.IOException if the named file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason

FileWriter

FileWriter(
    fileName: String!,
    append: Boolean)

Constructs a FileWriter given a file name and a boolean indicating whether to append the data written, using the platform's default charset.

Parameters
fileName String!: String The system-dependent filename.
append Boolean: boolean if true, then data will be written to the end of the file rather than the beginning.
Exceptions
java.io.IOException if the named file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason

FileWriter

FileWriter(
    fileName: String!,
    charset: Charset!)

Constructs a FileWriter given a file name and charset.

Parameters
fileName String!: the name of the file to write
charset Charset!: the charset
Exceptions
java.io.IOException if the named file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason

FileWriter

FileWriter(
    fileName: String!,
    charset: Charset!,
    append: Boolean)

Constructs a FileWriter given a file name, charset and a boolean indicating whether to append the data written.

Parameters
fileName String!: the name of the file to write
charset Charset!: the charset
append Boolean: a boolean. If true, the writer will write the data to the end of the file rather than the beginning.
Exceptions
java.io.IOException if the named file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason