BufferedWriter JDK 1.6)

Description

public class 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.

See also: PrintWriter FileWriter OutputStreamWriter

Methods

Hide/Show inherited methods

public Writer append (char c) throws IOException [Inherited From Writer]

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)

Returns: This writer
Parameters:
- c - The 16-bit character to append
Throws:
- IOException - If an I/O error occurs
Since: 1.5

public Writer append (CharSequence csq) throws IOException [Inherited From Writer]

Appends the specified character sequence to this writer.

An invocation of this method of the form out.append(csq) behaves in exactly the same way as the invocation

     out.write(csq.toString())

Depending on the specification of toString for the character sequence csq, the entire sequence may not be appended. For instance, invoking the toString method of a character buffer will return a subsequence whose content depends upon the buffer's position and limit.
Returns: This writer
Parameters:
- csq - The character sequence to append. If csq is null, then the four characters "null" are appended to this writer.
Throws:
- IOException - If an I/O error occurs
Since: 1.5

public Writer append (CharSequence csq, int start, int end) throws IOException [Inherited From Writer]

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

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

An invocation of this method of the form out.append(csq, start, end) when csq is not null behaves in exactly the same way as the invocation

     out.write(csq.subSequence(start, end).toString())

Returns: This writer
Parameters:
- csq - The character sequence from which a subsequence will be appended. If csq is null, then characters will be appended as if csq contained the four characters "null".
- start - The index of the first character in the subsequence
- end - The index of the character following the last character in the subsequence
Throws:
- IndexOutOfBoundsException - If start or end are negative, start is greater than end, or end is greater than csq.length()
- IOException - If an I/O error occurs
Since: 1.5

public void close () throws IOException [Specified in Writer]

public void flush () throws IOException [Specified in Writer]

Flushes the stream.

pack-private void flushBuffer () throws IOException

Flushes the output buffer to the underlying character stream, without flushing the stream itself.

public void newLine () throws IOException

Writes a line separator.

public void write (char[] cbuf) throws IOException [Inherited From Writer]

Writes an array of characters.

public void write (char[] cbuf, int off, int len) throws IOException [Specified in Writer]

Writes a portion of an array of characters.

public void write (int c) throws IOException [Overrides Writer]

Writes a single character.

public void write (String str) throws IOException [Inherited From Writer]

Writes a string.

public void write (String s, int off, int len) throws IOException [Overrides Writer]

Writes a portion of a String.