Package org.apache.commons.io.output
Class StringBuilderWriter
java.lang.Object
java.io.Writer
org.apache.commons.io.output.StringBuilderWriter
- All Implemented Interfaces:
- Closeable,- Flushable,- Serializable,- Appendable,- AutoCloseable
Writer implementation that outputs to a StringBuilder.
 
 NOTE: This implementation, as an alternative to StringWriter, provides an un-synchronized implementation for better
 performance for use in a single thread. For safe usage with multiple Threads, a StringWriter should be used.
 
Deprecating Serialization
Serialization is deprecated and will be removed in 3.0.
- Since:
- 2.0
- See Also:
- 
Field Summary
- 
Constructor SummaryConstructorsConstructorDescriptionConstructs a newStringBuilderinstance with default capacity.StringBuilderWriter(int capacity) Constructs a newStringBuilderinstance with the specified capacity.StringBuilderWriter(StringBuilder builder) Constructs a new instance with the specifiedStringBuilder.
- 
Method SummaryModifier and TypeMethodDescriptionappend(char value) Appends a single character to this Writer.append(CharSequence value) Appends a character sequence to this Writer.append(CharSequence value, int start, int end) Appends a portion of a character sequence to theStringBuilder.voidclose()Closing this writer has no effect.voidflush()Flushing this writer has no effect.Gets the underlying builder.toString()ReturnsStringBuilder.toString().voidwrite(char[] value, int offset, int length) Writes a portion of a character array to theStringBuilder.voidWrites a String to theStringBuilder.
- 
Constructor Details- 
StringBuilderWriterpublic StringBuilderWriter()Constructs a newStringBuilderinstance with default capacity.
- 
StringBuilderWriterConstructs a newStringBuilderinstance with the specified capacity.- Parameters:
- capacity- The initial capacity of the underlying- StringBuilder
 
- 
StringBuilderWriterConstructs a new instance with the specifiedStringBuilder.If builderis null a new instance with default capacity will be created.- Parameters:
- builder- The String builder. May be null.
 
 
- 
- 
Method Details- 
appendAppends a single character to this Writer.- Specified by:
- appendin interface- Appendable
- Overrides:
- appendin class- Writer
- Parameters:
- value- The character to append
- Returns:
- This writer instance
 
- 
appendAppends a character sequence to this Writer.- Specified by:
- appendin interface- Appendable
- Overrides:
- appendin class- Writer
- Parameters:
- value- The character to append
- Returns:
- This writer instance
 
- 
appendAppends a portion of a character sequence to theStringBuilder.- Specified by:
- appendin interface- Appendable
- Overrides:
- appendin class- Writer
- Parameters:
- value- The character to append
- start- The index of the first character
- end- The index of the last character + 1
- Returns:
- This writer instance
 
- 
closeClosing this writer has no effect.
- 
flushFlushing this writer has no effect.
- 
getBuilderGets the underlying builder.- Returns:
- The underlying builder
 
- 
toStringReturnsStringBuilder.toString().
- 
writeWrites a portion of a character array to theStringBuilder.
- 
writeWrites a String to theStringBuilder.
 
-