java.io

Class BufferedWriter

java.lang.Object

java.io.Writer

java.io.BufferedWriter

public class BufferedWriter
extends Writer

This class accumulates chars written in a buffer instead of immediately writing the data to the underlying output sink. The chars are instead as one large block when the buffer is filled, or when the stream is closed or explicitly flushed. This mode operation can provide a more efficient mechanism for writing versus doing numerous small unbuffered writes.

Author:

Aaron M. Renn (arenn@urbanophile.com), Tom Tromey

Field Summary

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor and Description
BufferedWriter(Writer out) This method initializes a new BufferedWriter instance that will write to the specified subordinate Writer and which will use a default buffer size of 8192 chars.
BufferedWriter(Writer ox, int size) This method initializes a new BufferedWriter instance that will write to the specified subordinate Writer and which will use the specified buffer size

Method Summary

Modifier and Type	Method and Description
void	close() This method flushes any remaining buffered chars then closes the underlying output stream.
void	flush() This method causes any currently buffered chars to be immediately written to the underlying output stream.
void	newLine() This method writes out a system depedent line separator sequence.
void	write(char[] buf, int offset, int len) This method writes len chars from the char array buf starting at position offset in the buffer.
void	write(int oneChar) This method writes a single char of data.
void	write(String str, int offset, int len) This method writes len chars from the String str starting at position offset in the string.

Methods inherited from class java.io.Writer

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)

This method initializes a new BufferedWriter instance that will write to the specified subordinate Writer and which will use a default buffer size of 8192 chars.

Parameters:

out - The underlying Writer to write data to

BufferedWriter

public BufferedWriter(Writer ox,
                      int size)

This method initializes a new BufferedWriter instance that will write to the specified subordinate Writer and which will use the specified buffer size

Parameters:

out - The underlying Writer to write data to

size - The size of the internal buffer

Method Detail

close

public void close()
           throws IOException

This method flushes any remaining buffered chars then closes the underlying output stream. Any further attempts to write to this stream may throw an exception

Specified by:

close in class Writer

Throws:

IOException - If an error occurs

flush

public void flush()
           throws IOException

This method causes any currently buffered chars to be immediately written to the underlying output stream.

Specified by:

flush in class Writer

Throws:

IOException - If an error occurs

newLine

public void newLine()
             throws IOException

This method writes out a system depedent line separator sequence. The actual value written is detemined from the line.separator system property.

Throws:

IOException - If an error occurs

write

public void write(int oneChar)
           throws IOException

This method writes a single char of data. This will be written to the buffer instead of the underlying data source. However, if the buffer is filled as a result of this write request, it will be flushed to the underlying output stream.

Overrides:

write in class Writer

Parameters:

b - The char of data to be written, passed as an int

Throws:

IOException - If an error occurs

write

public void write(char[] buf,
                  int offset,
                  int len)
           throws IOException

This method writes len chars from the char array buf starting at position offset in the buffer. These chars will be written to the internal buffer. However, if this write operation fills the buffer, the buffer will be flushed to the underlying output stream.

Specified by:

write in class Writer

Parameters:

buf - The array of chars to write.

offset - The index into the char array to start writing from.

len - The number of chars to write.

Throws:

IOException - If an error occurs

write

public void write(String str,
                  int offset,
                  int len)
           throws IOException

This method writes len chars from the String str starting at position offset in the string. These chars will be written to the internal buffer. However, if this write operation fills the buffer, the buffer will be flushed to the underlying output stream.

Overrides:

write in class Writer

Parameters:

str - The String to write.

offset - The index into the string to start writing from.

len - The number of chars to write.

Throws:

IOException - If an error occurs