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.

Closing a StringWriter has no effect. The methods in this class can be called after the stream has been closed without generating an IOException.

Inherited Field Summary

From class java.io.Writer

protected Object

lock

The object used to synchronize operations on this stream.

Public 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.

Public Method Summary

StringWriter	append(char c) Appends the specified character to this writer.
StringWriter	append(CharSequence csq, int start, int end) Appends a subsequence of the specified character sequence to this writer.
StringWriter	append(CharSequence csq) Appends the specified character sequence to this writer.
void	close() Closing a StringWriter has no effect.
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(String str) Write a string.
void	write(int c) Write a single character.
void	write(String str, int off, int len) Write a portion of a string.
void	write(char[] cbuf, int off, int len) Write a portion of an array of characters.

Inherited Method Summary

From class java.io.Writer

Writer	append(char c) Appends the specified character to this writer.
Writer	append(CharSequence csq, int start, int end) Appends a subsequence of the specified character sequence to this writer.
Writer	append(CharSequence csq) Appends the specified character sequence to this writer.
abstract void	close() Closes the stream, flushing it first.
abstract void	flush() Flushes the stream.
void	write(String str) Writes a string.
void	write(int c) Writes a single character.
void	write(String str, int off, int len) Writes a portion of a string.
abstract void	write(char[] cbuf, int off, int len) Writes a portion of an array of characters.
void	write(char[] cbuf) Writes an array of characters.

From class java.lang.Object

Object	clone() Creates and returns a copy of this Object.
boolean	equals(Object obj) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of Class that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long timeout, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait(long timeout) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.

From interface java.lang.Appendable

abstract Appendable	append(char c) Appends the specified character to this Appendable.
abstract Appendable	append(CharSequence csq, int start, int end) Appends a subsequence of the specified character sequence to this Appendable.
abstract Appendable	append(CharSequence csq) Appends the specified character sequence to this Appendable.

From interface java.io.Closeable

abstract void

close() Closes this stream and releases any system resources associated with it.

From interface java.io.Flushable

abstract void

flush() Flushes this stream by writing any buffered output to the underlying stream.

From interface java.lang.AutoCloseable

abstract void

close() Closes this resource, relinquishing any underlying resources.

Public Constructors

public StringWriter ()

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

public StringWriter (int initialSize)

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

Parameters

initialSize	The number of char values that will fit into this buffer before it is automatically expanded

Throws

IllegalArgumentException	If initialSize is negative

Public Methods

public StringWriter append (char c)

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) 

Parameters

c	The 16-bit character to append

Returns

• This writer

public StringWriter append (CharSequence csq, int start, int end)

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

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()) 

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

Returns

• This writer

Throws

IndexOutOfBoundsException	If start or end are negative, start is greater than end, or end is greater than csq.length()

public StringWriter append (CharSequence csq)

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.

Parameters

csq	The character sequence to append. If csq is null, then the four characters "null" are appended to this writer.

Returns

• This writer

public void close ()

Closing a StringWriter has no effect. The methods in this class can be called after the stream has been closed without generating an IOException.

Throws

IOException

public void flush ()

Flush the stream.

public StringBuffer getBuffer ()

Return the string buffer itself.

Returns

• StringBuffer holding the current buffer value.

public String toString ()

Return the buffer's current value as a string.

Returns

• a printable representation of this object.

public void write (String str)

Write a string.

Parameters

str	String to be written

public void write (int c)

Write a single character.

Parameters

c	int specifying a character to be written

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

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