jsimple.io

Class StringWriter

java.lang.Object

jsimple.lang.AutoCloseable

jsimple.io.Writer

jsimple.io.StringWriter

All Implemented Interfaces:

java.lang.AutoCloseable

public class StringWriter
extends Writer

This class was based on, and modified from, the Apache Harmony java.io.StringWriter class. Unlike the standard Java StringWriter class, this doesn't do locking, doesn't throw any checked exceptions, and uses a StringBuilder internally instead of a StringBuffer (so it should be more efficient, though it's not intended to be thread safe).

A specialized Writer that writes characters to a StringBuffer in a sequential manner, appending them in the process. The result can later be queried using the StringWriter(int) or toString() methods.

See Also:

StringReader

Constructor Summary

Constructors

Constructor and Description
StringWriter() Constructs a new StringWriter which has a StringBuffer allocated with the default size of 16 characters.
StringWriter(int initialSize) Constructs a new StringWriter which has a StringBuffer allocated with a size of initialSize characters.

Method Summary

Modifier and Type	Method and Description
void	close() Calling this method has no effect.
void	flush() Calling this method has no effect.
java.lang.StringBuilder	getBuffer() Gets a reference to this writer's internal StringBuilder.
java.lang.String	toString() Gets a copy of the contents of this writer as a string.
void	write(char[] cbuf, int offset, int count) Writes count characters starting at offset in buffer to this writer's StringBuffer.
void	write(int oneChar) Writes one character to this writer's StringBuffer.
void	write(java.lang.String str) Writes the characters from the specified string to this writer's StringBuffer.
void	write(java.lang.String str, int offset, int count) Writes count characters from str starting at offset to this writer's StringBuffer.

Methods inherited from class jsimple.io.Writer

getLineSeparator, setLineSeparator, write, writeln, writeln

Methods inherited from class java.lang.Object

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

Constructor Detail

StringWriter

public StringWriter()

Constructs a new StringWriter which has a StringBuffer allocated with the default size of 16 characters. The StringBuffer is also the lock used to synchronize access to this writer.

StringWriter

public StringWriter(int initialSize)

Constructs a new StringWriter which has a StringBuffer allocated with a size of initialSize characters. The StringBuffer is also the lock used to synchronize access to this writer.

Parameters:

initialSize - the initial size of the target string buffer.

Method Detail

close

public void close()

Calling this method has no effect. In contrast to most Writer subclasses, the other methods in StringWriter do not throw an IOException if close() has been called.

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in class Writer

flush

public void flush()

Calling this method has no effect.

Specified by:

flush in class Writer

getBuffer

public java.lang.StringBuilder getBuffer()

Gets a reference to this writer's internal StringBuilder. Any changes made to the returned buffer are reflected in this writer.

Returns:

a reference to this writer's internal StringBuilder.

toString

public java.lang.String toString()

Gets a copy of the contents of this writer as a string.

Overrides:

toString in class java.lang.Object

Returns:

this writer's contents as a string.

write

public void write(char[] cbuf,
                  int offset,
                  int count)

Writes count characters starting at offset in buffer to this writer's StringBuffer.

Specified by:

write in class Writer

Parameters:

cbuf - the non-null character array to write.

offset - the index of the first character in cbuf to write.

count - the maximum number of characters to write.

write

public void write(int oneChar)

Writes one character to this writer's StringBuffer. Only the two least significant bytes of the integer oneChar are written.

Overrides:

write in class Writer

Parameters:

oneChar - the character to write to this writer's StringBuffer.

write

public void write(java.lang.String str)

Writes the characters from the specified string to this writer's StringBuffer.

Overrides:

write in class Writer

Parameters:

str - the non-null string containing the characters to write.

write

public void write(java.lang.String str,
                  int offset,
                  int count)

Writes count characters from str starting at offset to this writer's StringBuffer.

Overrides:

write in class Writer

Parameters:

str - the non-null string containing the characters to write.

offset - the index of the first character in str to write.

count - the number of characters from str to write.