Package org.apache.groovy.io
Class StringBuilderWriter
java.lang.Object
java.io.Writer
org.apache.groovy.io.StringBuilderWriter
- All Implemented Interfaces:
java.io.Closeable,java.io.Flushable,java.io.Serializable,java.lang.Appendable,java.lang.AutoCloseable
public class StringBuilderWriter
extends java.io.Writer
implements java.io.Serializable
Copied from https://github.com/apache/commons-io/blob/master/src/main/java/org/apache/commons/io/output/StringBuilderWriter.java
Writer implementation that outputs to a StringBuilder.
NOTE: This implementation, as an alternative to
java.io.StringWriter, provides an un-synchronized
(i.e. for use in a single thread) implementation for better performance.
For safe usage with multiple Threads then
java.io.StringWriter should be used.
- Since:
- 2.0
- See Also:
- Serialized Form
-
Field Summary
Fields inherited from class java.io.Writer
lock -
Constructor Summary
Constructors Constructor Description StringBuilderWriter()Constructs a newStringBuilderinstance with default capacity.StringBuilderWriter(int capacity)Constructs a newStringBuilderinstance with the specified capacity.StringBuilderWriter(java.lang.StringBuilder builder)Constructs a new instance with the specifiedStringBuilder. -
Method Summary
Modifier and Type Method Description java.io.Writerappend(char value)Appends a single character to this Writer.java.io.Writerappend(java.lang.CharSequence value)Appends a character sequence to this Writer.java.io.Writerappend(java.lang.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.java.lang.StringBuildergetBuilder()Returns the underlying builder.java.lang.StringtoString()ReturnsStringBuilder.toString().voidwrite(char[] value, int offset, int length)Writes a portion of a character array to theStringBuilder.voidwrite(java.lang.String value)Writes a String to theStringBuilder.Methods inherited from class java.io.Writer
nullWriter, write, write, writeMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Constructor Details
-
StringBuilderWriter
public StringBuilderWriter()Constructs a newStringBuilderinstance with default capacity. -
StringBuilderWriter
public StringBuilderWriter(int capacity)Constructs a newStringBuilderinstance with the specified capacity.- Parameters:
capacity- The initial capacity of the underlyingStringBuilder
-
StringBuilderWriter
public StringBuilderWriter(java.lang.StringBuilder builder)Constructs 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
-
append
public java.io.Writer append(char value)Appends a single character to this Writer.- Specified by:
appendin interfacejava.lang.Appendable- Overrides:
appendin classjava.io.Writer- Parameters:
value- The character to append- Returns:
- This writer instance
-
append
public java.io.Writer append(java.lang.CharSequence value)Appends a character sequence to this Writer.- Specified by:
appendin interfacejava.lang.Appendable- Overrides:
appendin classjava.io.Writer- Parameters:
value- The character to append- Returns:
- This writer instance
-
append
public java.io.Writer append(java.lang.CharSequence value, int start, int end)Appends a portion of a character sequence to theStringBuilder.- Specified by:
appendin interfacejava.lang.Appendable- Overrides:
appendin classjava.io.Writer- Parameters:
value- The character to appendstart- The index of the first characterend- The index of the last character + 1- Returns:
- This writer instance
-
close
public void close()Closing this writer has no effect.- Specified by:
closein interfacejava.lang.AutoCloseable- Specified by:
closein interfacejava.io.Closeable- Specified by:
closein classjava.io.Writer
-
flush
public void flush()Flushing this writer has no effect.- Specified by:
flushin interfacejava.io.Flushable- Specified by:
flushin classjava.io.Writer
-
write
public void write(java.lang.String value)Writes a String to theStringBuilder.- Overrides:
writein classjava.io.Writer- Parameters:
value- The value to write
-
write
public void write(char[] value, int offset, int length)Writes a portion of a character array to theStringBuilder.- Specified by:
writein classjava.io.Writer- Parameters:
value- The value to writeoffset- The index of the first characterlength- The number of characters to write
-
getBuilder
public java.lang.StringBuilder getBuilder()Returns the underlying builder.- Returns:
- The underlying builder
-
toString
public java.lang.String toString()ReturnsStringBuilder.toString().- Overrides:
toStringin classjava.lang.Object- Returns:
- The contents of the String builder.
-