org.springframework.extensions.surf.util
Class StringBuilderWriter

java.lang.Object
  java.io.Writer
      org.springframework.extensions.surf.util.StringBuilderWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable

public class StringBuilderWriter
extends Writer

This is a direct copy of the JDK java.io.StringWriter class but modified to write to a StringBuilder rather than the older, slower StringBuffer class. Obviously this class is therefore not thread safe and synchronization should be provided at the application level if required.

Original source comments:

A character stream that collects its output in a string builder, 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.

Version:

1.24, 04/07/16

Author:

Mark Reinhold

Field Summary

Fields inherited from class java.io.Writer

lock

Constructor Summary

StringBuilderWriter()
Create a new string writer, using the default initial string-builder size.

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

Method Summary

StringBuilderWriter	append(char c) Appends the specified character to this writer.
StringBuilderWriter	append(CharSequence csq) Appends the specified character sequence to this writer.
StringBuilderWriter	append(CharSequence csq, int start, int end) Appends a subsequence of the specified character sequence to this writer.
void	close() Closing a StringWriter has no effect.
void	flush() Flush the stream.
StringBuilder	getBuffer() Return the string builder 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, wait, wait, wait

Constructor Detail

StringBuilderWriter

public StringBuilderWriter()

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

StringBuilderWriter

public StringBuilderWriter(int initialSize)

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

Parameters:

initialSize - an int specifying the initial size of the builder.

Method Detail

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.

Specified by:

write in class Writer

Parameters:

cbuf - Array of characters

off - Offset from which to start writing characters

len - Number of characters to write

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.

Overrides:

write in class Writer

Parameters:

str - String to be written

off - Offset from which to start writing characters

len - Number of characters to write

append

public StringBuilderWriter 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.

Specified by:

append in interface Appendable

Overrides:

append in class Writer

Parameters:

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

Returns:

This writer

Since:

1.5

append

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

Specified by:

append in interface Appendable

Overrides:

append in class Writer

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

Since:

1.5

append

public StringBuilderWriter 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)
 

Specified by:

append in interface Appendable

Overrides:

append in class Writer

Parameters:

c - The 16-bit character to append

Returns:

This writer

Since:

1.5

toString

public String toString()

Return the buffer's current value as a string.

Overrides:

toString in class Object

getBuffer

public StringBuilder getBuffer()

Return the string builder itself.

Returns:

StringBuilder holding the current buffer value.

flush

public void flush()

Flush the stream.

Specified by:

flush in interface Flushable

Specified by:

flush in class Writer

close

public void close()
           throws IOException

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

Specified by:

close in interface Closeable

Specified by:

close in class Writer

Throws:

IOException