java::io::BufferedWriter Class Reference

Inheritance diagram for java::io::BufferedWriter:

Inheritance graph
java::lang::Objectjava::lang::Interfacejava::io::Writer
[legend]
Collaboration diagram for java::io::BufferedWriter:

Collaboration graph
java::lang::Objectjava::lang::Interfacejava::lang::ObjectRefjava::io::Writerjava::lang::Comparable
[legend]

List of all members.


Detailed Description

Write 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 ('
') 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.

Version:
1.23, 01/12/03
Author:
Mark Reinhold
Since:
JDK1.1

Public Member Functions

 BufferedWriter (const Ref< Writer > &out=0, jint size=8192)
 Create a new buffered character-output stream that uses an output buffer of the given size.
virtual void write (jint b)
 Write a single character.
virtual void write (const Array< jchar > &b, jint off=0, jint len=-1)
 Write a portion of an array of characters.
virtual void write (const String &str, jint off=0, jint len=-1)
 Write a portion of a string.
virtual void newLine ()
 Write a line separator.
virtual void flush ()
 Flush the stream.
virtual void close ()
 Close the stream.

Constructor & Destructor Documentation

java::io::BufferedWriter::BufferedWriter ( const Ref< Writer > &  out = 0,
jint  size = 8192 
)

Create 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
Exceptions:
IllegalArgumentException If sz is <= 0


Member Function Documentation

virtual void java::io::BufferedWriter::write ( jint  b  )  [virtual]

Write a single character.

Exceptions:
IOException If an I/O error occurs

Implements java::io::Writer.

virtual void java::io::BufferedWriter::write ( const Array< jchar > &  b,
jint  off = 0,
jint  len = -1 
) [virtual]

Write 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 A character array
off Offset from which to start reading characters
len Number of characters to write
Exceptions:
IOException If an I/O error occurs

Implements java::io::Writer.

virtual void java::io::BufferedWriter::write ( const String str,
jint  off = 0,
jint  len = -1 
) [virtual]

Write a portion of a string.

Parameters:
str A String
off Offset from which to start writing characters
len Number of characters to write
Exceptions:
IOException If an I/O error occurs

Implements java::io::Writer.

virtual void java::io::BufferedWriter::newLine (  )  [virtual]

Write a line separator.

The line separator string is defined by the system property line.separator, and is not necessarily a single newline ('
') character.

Exceptions:
IOException If an I/O error occurs

virtual void java::io::BufferedWriter::flush (  )  [virtual]

Flush the stream.

Exceptions:
IOException If an I/O error occurs

Reimplemented from java::io::Writer.

virtual void java::io::BufferedWriter::close (  )  [virtual]

Close the stream.

Exceptions:
IOException If an I/O error occurs

Reimplemented from java::io::Writer.


The documentation for this class was generated from the following file:
Generated on Fri May 16 11:56:26 2008 for CrossPlatformJavaLikeC++API by  doxygen 1.5.3