java.io

Class StringWriter

public class StringWriter extends Writer

This class writes chars to an internal StringBuffer that can then be used to retrieve a String.

Constructor Summary
	StringWriter() This method initializes a new `StringWriter` to write to a `StringBuffer` initially sized to a default size of 16 chars.
	StringWriter(int size) This method initializes a new `StringWriter` to write to a `StringBuffer` with the specified initial size.

Method Summary
StringWriter	append(char c)
StringWriter	append(CharSequence cs)
StringWriter	append(CharSequence cs, int start, int end)
void	close() This method closes the stream.
void	flush() This method flushes any buffered characters to the underlying output.
StringBuffer	getBuffer() This method returns the `StringBuffer` object that this object is writing to.
String	toString() This method returns the contents of the internal `StringBuffer` as a `String`.
void	write(int oneChar) This method writes a single character to the output, storing it in the internal buffer.
void	write(char[] chars, int offset, int len) This method writes `len` chars from the specified array starting at index `offset` in that array to this stream by appending the chars to the end of the internal buffer.
void	write(String str) This method writes the characters in the specified `String` to the stream by appending them to the end of the internal buffer.
void	write(String str, int offset, int len) This method writes out `len` characters of the specified `String` to the stream starting at character position `offset` into the stream.

Constructor Detail

StringWriter

public StringWriter()

This method initializes a new StringWriter to write to a StringBuffer initially sized to a default size of 16 chars.

StringWriter

public StringWriter(int size)

This method initializes a new StringWriter to write to a StringBuffer with the specified initial size.

Parameters: size The initial size to make the StringBuffer

Method Detail

append

public StringWriter append(char c)

Since: 1.5

append

public StringWriter append(CharSequence cs)

Since: 1.5

append

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

Since: 1.5

close

public void close()

This method closes the stream. The contents of the internal buffer can still be retrieved, but future writes are not guaranteed to work.

Throws: IOException If an error orrurs.

flush

public void flush()

This method flushes any buffered characters to the underlying output. It does nothing in this class.

getBuffer

public StringBuffer getBuffer()

This method returns the StringBuffer object that this object is writing to. Note that this is the actual internal buffer, so any operations performed on it will affect this stream object.

Returns: The StringBuffer object being written to

toString

public String toString()

This method returns the contents of the internal StringBuffer as a String.

Returns: A String representing the chars written to this stream.

write

public void write(int oneChar)

This method writes a single character to the output, storing it in the internal buffer.

Parameters: oneChar The char to write, passed as an int.

write

public void write(char[] chars, int offset, int len)

This method writes len chars from the specified array starting at index offset in that array to this stream by appending the chars to the end of the internal buffer.

Parameters: chars The array of chars to write offset The index into the array to start writing from len The number of chars to write

write

public void write(String str)

This method writes the characters in the specified String to the stream by appending them to the end of the internal buffer.

Parameters: str The String to write to the stream.

write

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

This method writes out len characters of the specified String to the stream starting at character position offset into the stream. This is done by appending the characters to the internal buffer.

Parameters: str The String to write characters from offset The character position to start writing from len The number of characters to write.