BufferedWriter

open class BufferedWriter : Writer

port of java.io.BufferedWriter

Writes text to a character-output stream, buffering characters so as to provide for the efficient writing of single characters, arrays, and strings.

The buffer size may be specified, or the default size may be accepted. The default is large enough for most purposes.

A newLine() method is provided, which uses the platform's own notion of line separator as defined by the system property line.separator. Not all platforms use the newline character ('\n') to terminate lines. Calling this method to terminate each output line is therefore preferred to writing a newline character directly.

In general, a Writer sends its output immediately to the underlying character or byte stream. Unless prompt output is required, it is advisable to wrap a BufferedWriter around any Writer whose write() operations may be costly, such as FileWriters and OutputStreamWriters. For example,

{@snippet lang=java :

  • PrintWriter out = new PrintWriter(new BufferedWriter(new FileWriter("foo.out")));
  • }

will buffer the PrintWriter's output to the file. Without buffering, each invocation of a print() method would cause characters to be converted into bytes that would then be written immediately to the file, which can be very inefficient.

Author

Mark Reinhold

Since

1.1

See also

FileWriter
java.nio.file.Files.newBufferedWriter

Constructors

Link copied to clipboard
constructor(out: Writer)

Creates a buffered character-output stream that uses a default-sized output buffer.

constructor(out: Writer, sz: Int)

Creates a new buffered character-output stream that uses an output buffer of the given size.

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard
open override fun append(c: Char): Writer

Appends the specified character to this writer.

open override fun append(csq: CharSequence?): Writer

Appends the specified character sequence to this writer.

open override fun append(csq: CharSequence?, start: Int, end: Int): Writer

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

Link copied to clipboard
open override fun close()

Closes the stream, flushing it first. Once the stream has been closed, further write() or flush() invocations will cause an IOException to be thrown. Closing a previously closed stream has no effect.

Link copied to clipboard
open override fun flush()

Flushes the stream.

Link copied to clipboard

Flushes the output buffer to the underlying character stream, without flushing the stream itself. This method is non-private only so that it may be invoked by PrintStream.

Link copied to clipboard
fun newLine()

Writes a line separator. The line separator string is defined by the system property line.separator, and is not necessarily a single newline ('\n') character.

Link copied to clipboard
open override fun write(c: Int)

Writes a single character.

open override fun write(cbuf: CharArray, off: Int, len: Int)

Writes a portion of an array of characters.

open override fun write(s: String, off: Int, len: Int)

Writes a portion of a String.

open fun write(cbuf: CharArray)

Writes an array of characters.

open fun write(str: String)

Writes a string.