This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


java.io
class BufferedWriter

java.lang.Object extended by java.io.Writer extended by java.io.BufferedWriter
All Implemented Interfaces:
Closeable, Flushable, Appendable

Most common way to construct:

FileWriter fw = …;

BufferedWriter bw = new BufferedWriter(fw);

Based on 50 examples


public class BufferedWriter
extends Writer

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 (auto-generated):

BufferedReader

File

StringBuffer


Field Summary
 
Fields inherited from class java.io.Writer
lock
 
Constructor Summary

          Creates a buffered character-output stream that uses a default-sized output buffer.
BufferedWriter(Writer out, int sz)

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

          Closes the stream, flushing it first.
 void

          Flushes the stream.
 void

          Writes a line separator.
 void
write(char[] cbuf, int off, int len)

          Writes a portion of an array of characters.
 void
write(int c)

          Writes a single character.
 void
write(String s, int off, int len)

          Writes a portion of a String.
 
Methods inherited from class java.io.Writer
append, append, append, close, flush, write, write, write, write, write
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BufferedWriter

public BufferedWriter(Writer out)
Creates a buffered character-output stream that uses a default-sized output buffer.

Parameters:
out - A Writer

BufferedWriter

public BufferedWriter(Writer out,
                      int sz)
Creates a new buffered character-output stream that uses an output buffer of the given size.

Parameters:
out - A Writer
sz - Output-buffer size, a positive integer
Method Detail

close

public void close()
           throws IOException
Overrides:
close in class Writer
Throws:
IOException

flush

public void flush()
           throws IOException
Flushes the stream.

Overrides:
flush in class Writer
Throws:
IOException - If an I/O error occurs

newLine

public void newLine()
             throws IOException
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:
IOException - If an I/O error occurs

write

public void write(char[] cbuf,
                  int off,
                  int len)
           throws IOException
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.

Overrides:
write in class Writer
Parameters:
cbuf - A character array
off - Offset from which to start reading characters
len - Number of characters to write
Throws:
IOException - If an I/O error occurs

write

public void write(int c)
           throws IOException
Writes a single character.

Overrides:
write in class Writer
Parameters:
c
Throws:
IOException - If an I/O error occurs

write

public void write(String s,
                  int off,
                  int len)
           throws IOException
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 {@linkplain java.io.Writer#write(java.lang.String,int,int) superclass}, which requires that an {@link IndexOutOfBoundsException} be thrown.

Overrides:
write in class Writer
Parameters:
s - String to be written
off - Offset from which to start reading characters
len - Number of characters to be written
Throws:
IOException - If an I/O error occurs


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.