FileWriter

public class FileWriter
extends OutputStreamWriter

java.lang.Object
   ↳ java.io.Writer
     ↳ java.io.OutputStreamWriter
       ↳ java.io.FileWriter


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

Inherited fields

protected Object lock

The object used to synchronize operations on this stream.

Public constructors

FileWriter(File file)

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

FileWriter(File file, boolean append)

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, boolean append)

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

FileWriter(FileDescriptor fd)

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

FileWriter(String fileName)

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

FileWriter(String fileName, boolean append)

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

FileWriter(String fileName, Charset charset)

Constructs a FileWriter given a file name and charset.

FileWriter(String fileName, Charset charset, boolean append)

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

Inherited methods

Writer append(CharSequence csq, int start, int end)

Appends a subsequence of the specified character sequence to this writer.

Writer append(CharSequence csq)

Appends the specified character sequence to this writer.

void close()

Closes the stream, flushing it first.

void flush()

Flushes the stream.

String getEncoding()

Returns the name of the character encoding being used by this stream.

void write(int c)

Writes a single character.

void write(String str, int off, int len)

Writes a portion of a string.

void write(char[] cbuf, int off, int len)

Writes a portion of an array of characters.

Writer append(char c)

Appends the specified character to this writer.

Writer append(CharSequence csq, int start, int end)

Appends a subsequence of the specified character sequence to this writer.

Writer append(CharSequence csq)

Appends the specified character sequence to this writer.

abstract void close()

Closes the stream, flushing it first.

abstract void flush()

Flushes the stream.

static Writer nullWriter()

Returns a new Writer which discards all characters.

void write(String str)

Writes a string.

void write(int c)

Writes a single character.

void write(String str, int off, int len)

Writes a portion of a string.

abstract void write(char[] cbuf, int off, int len)

Writes a portion of an array of characters.

void write(char[] cbuf)

Writes an array of characters.

Object clone()

Creates and returns a copy of this object.

boolean equals(Object obj)

Indicates whether some other object is "equal to" this one.

void finalize()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

final Class<?> getClass()

Returns the runtime class of this Object.

int hashCode()

Returns a hash code value for the object.

final void notify()

Wakes up a single thread that is waiting on this object's monitor.

final void notifyAll()

Wakes up all threads that are waiting on this object's monitor.

String toString()

Returns a string representation of the object.

final void wait(long timeoutMillis, int nanos)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait(long timeoutMillis)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait()

Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

abstract Appendable append(char c)

Appends the specified character to this Appendable.

abstract Appendable append(CharSequence csq, int start, int end)

Appends a subsequence of the specified character sequence to this Appendable.

abstract Appendable append(CharSequence csq)

Appends the specified character sequence to this Appendable.

abstract void close()

Closes this stream and releases any system resources associated with it.

abstract void flush()

Flushes this stream by writing any buffered output to the underlying stream.

abstract void close()

Closes this resource, relinquishing any underlying resources.

Public constructors

FileWriter

Added in API level 1
public FileWriter (File file)

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

Parameters
file File: the File to write.

Throws
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

Added in API level 1
public FileWriter (File file, 
                boolean append)

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

Throws
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

Added in API level 33
public 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

Throws
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

Added in API level 33
public FileWriter (File file, 
                Charset charset, 
                boolean append)

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.

Throws
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

Added in API level 1
public FileWriter (FileDescriptor fd)

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

Parameters
fd FileDescriptor: the FileDescriptor to write.

FileWriter

Added in API level 1
public FileWriter (String fileName)

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

Parameters
fileName String: String The system-dependent filename.

Throws
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

Added in API level 1
public FileWriter (String fileName, 
                boolean append)

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.

Throws
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

Added in API level 33
public FileWriter (String fileName, 
                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

Throws
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

Added in API level 33
public FileWriter (String fileName, 
                Charset charset, 
                boolean append)

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.

Throws
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