BufferedWriter

open class BufferedWriter : Writer
kotlin.Any
   ↳ java.io.Writer
   ↳ 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,

 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.

Summary

Public constructors
<init>(out: Writer!)

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

<init>(out: Writer!, sz: Int)

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

Public methods
open Unit
write(c: Int)

Writes a single character.

open Unit
write(cbuf: CharArray!, off: Int, len: Int)

Writes a portion of an array of characters.

open Unit
write(s: String!, off: Int, len: Int)

Writes a portion of a String.

open Unit

Flushes the stream.

open Unit

Writes a line separator.

open Unit

Inherited functions
Inherited properties

Public constructors

<init>

BufferedWriter(out: Writer!)

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

Parameters
out Writer!: A Writer

<init>

BufferedWriter(out: Writer!, sz: Int)

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

Parameters
out Writer!: A Writer
sz Writer!: Output-buffer size, a positive integer
Exceptions
IllegalArgumentException If sz <= 0

Public methods

write

open fun write(c: Int): Unit

Writes a single character.

Parameters
c Int: int specifying a character to be written
Exceptions
IOException If an I/O error occurs
IOException If an I/O error occurs

write

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

Writes a portion of an array of characters.

Ordinarily this method stores characters from the given array into this stream's buffer, flushing the buffer to the underlying stream as needed. If the requested length is at least as large as the buffer, however, then this method will flush the buffer and write the characters directly to the underlying stream. Thus redundant BufferedWriters will not copy data unnecessarily.

Parameters
cbuf CharArray!: A character array
off CharArray!: Offset from which to start reading characters
len CharArray!: Number of characters to write
Exceptions
IOException If an I/O error occurs
IOException If an I/O error occurs

write

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

Writes a portion of a String.

If the value of the len parameter is negative then no characters are written. This is contrary to the specification of this method in the superclass, which requires that an IndexOutOfBoundsException be thrown.

Parameters
str String!: A String
off String!: Offset from which to start reading characters
len String!: Number of characters to be written
s String!: String to be written
Exceptions
IndexOutOfBoundsException If off is negative, or len is negative, or off+len is negative or greater than the length of the given string
IOException If an I/O error occurs
IOException If an I/O error occurs

flush

open fun flush(): Unit

Flushes the stream.

Exceptions
IOException If an I/O error occurs
IOException If an I/O error occurs

newLine

open fun newLine(): Unit

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.

Exceptions
IOException If an I/O error occurs

close

open fun close(): Unit