java.io
Class StringWriter

java.lang.Object
  |
  +--java.io.Writer
        |
        +--java.io.StringWriter

public class StringWriter

extends Writer

A character stream that collects its output in a string buffer, which can then be used to construct a string.

Since:

JDK1.1

Field Summary

private StringBuffer	buf
private boolean	isClosed Flag indicating whether the stream has been closed.

Fields inherited from class java.io.Writer

lock, writeBuffer, writeBufferSize

Constructor Summary

StringWriter()
Create a new string writer, using the default initial string-buffer size.

StringWriter(int initialSize)
Create a new string writer, using the specified initial string-buffer size.

Method Summary

void	close() Close the stream.
private void	ensureOpen() Check to make sure that the stream has not been closed
void	flush() Flush the stream.
StringBuffer	getBuffer() Return the string buffer itself.
String	toString() Return the buffer's current value as a string.
void	write(char[] cbuf, int off, int len) Write a portion of an array of characters.
void	write(int c) Write a single character.
void	write(String str) Write a string.
void	write(String str, int off, int len) Write a portion of a string.

Methods inherited from class java.io.Writer

write

Methods inherited from class java.lang.Object

, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, wait, wait, wait

Field Detail

buf

private StringBuffer buf

isClosed

private boolean isClosed

Flag indicating whether the stream has been closed.

Constructor Detail

StringWriter

public StringWriter()

Create a new string writer, using the default initial string-buffer size.

StringWriter

public StringWriter(int initialSize)

Create a new string writer, using the specified initial string-buffer size.

Method Detail

ensureOpen

private void ensureOpen()

Check to make sure that the stream has not been closed

write

public void write(int c)

Write a single character.

Overrides:

write in class Writer

write

public void write(char[] cbuf,
                  int off,
                  int len)

Write a portion of an array of characters.

Parameters:

cbuf - Array of characters

off - Offset from which to start writing characters

len - Number of characters to write

Overrides:

write in class Writer

write

public void write(String str)

Write a string.

Overrides:

write in class Writer

write

public void write(String str,
                  int off,
                  int len)

Write a portion of a string.

Parameters:

str - String to be written

off - Offset from which to start writing characters

len - Number of characters to write

Overrides:

write in class Writer

toString

public String toString()

Return the buffer's current value as a string.

Overrides:

toString in class Object

getBuffer

public StringBuffer getBuffer()

Return the string buffer itself.

flush

public void flush()

Flush the stream.

Overrides:

flush in class Writer

close

public void close()
           throws IOException

Close the stream. This method does not release the buffer, since its contents might still be required.

Overrides:

close in class Writer