jdk.io.BufferedWriter — clojure-interop/java.io 1.0.5

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.

->buffered-writer clj

(->buffered-writer out)

(->buffered-writer out sz)

Constructor.

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

out - A Writer - java.io.Writer sz - Output-buffer size, a positive integer - int

throws: java.lang.IllegalArgumentException - If sz <= 0

close clj

(close this)

Description copied from class: Writer

throws: java.io.IOException - If an I/O error occurs

flush clj

(flush this)

Flushes the stream.

throws: java.io.IOException - If an I/O error occurs

new-line clj

(new-line this)

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.

throws: java.io.IOException - If an I/O error occurs

write clj

(write this c)

(write this cbuf off len)

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.

cbuf - A character array - char[] off - Offset from which to start reading characters - int len - Number of characters to write - int

throws: java.io.IOException - If an I/O error occurs