Apache Groovy 3.0.20 · org.apache.groovy.io.StringBuilderWriter

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.

Modifier and Type	Field and Description
private final StringBuilder	builder
private static final long	serialVersionUID

Constructor Summary

Access	Constructor and Description
public	StringBuilderWriter() Constructs a new `StringBuilder` instance with default capacity.
public	StringBuilderWriter(final int The initial capacity of the underlying `StringBuilder` capacity) Constructs a new `StringBuilder` instance with the specified capacity.
public	StringBuilderWriter(final StringBuilder The String builder. May be null. builder) Constructs a new instance with the specified `StringBuilder`.

Method Summary

Modifier and Type	Method and Description
public Writer	Returns: This writer instance append(final char The character to append value) Overrides java.io.Writer.append. Implements java.lang.Appendable.append. Appends a single character to this Writer.
public Writer	Returns: This writer instance append(final CharSequence The character to append value) Overrides java.io.Writer.append. Implements java.lang.Appendable.append. Appends a character sequence to this Writer.
public Writer	Returns: This writer instance append(final CharSequence The character to append value, final int The index of the first character start, final int The index of the last character + 1 end) Overrides java.io.Writer.append. Implements java.lang.Appendable.append. Appends a portion of a character sequence to the `StringBuilder`.
public void	close() Implements abstract java.io.Writer.close. Implements java.io.Closeable.close. Closing this writer has no effect.
public void	flush() Implements abstract java.io.Writer.flush. Implements java.io.Flushable.flush. Flushing this writer has no effect.
public StringBuilder	Returns: The underlying builder getBuilder() Returns the underlying builder.
public String	Returns: The contents of the String builder. toString() Overrides java.lang.Object.toString. Returns `StringBuilder#toString()`.
public void	write(final String The value to write value) Overrides java.io.Writer.write. Writes a String to the `StringBuilder`.
public void	write(final char[] The value to write value, final int The index of the first character offset, final int The number of characters to write length) Implements abstract java.io.Writer.write. Writes a portion of a character array to the `StringBuilder`.

Inherited from java.io.Writer:: nullWriter write write write

Field Detail

builder	back to summary
private final StringBuilder builder

serialVersionUID	back to summary
private static final long serialVersionUID

Constructor Detail

StringBuilderWriter	back to summary
public StringBuilderWriter() Constructs a new `StringBuilder` instance with default capacity.

StringBuilderWriter back to summary

StringBuilderWriter	back to summary
public StringBuilderWriter(final int capacity) Constructs a new `StringBuilder` instance with the specified capacity. Parameters capacity:int The initial capacity of the underlying `StringBuilder`

public StringBuilderWriter(final int capacity)

Constructs a new StringBuilder instance with the specified capacity.

Parameters

capacity:int: The initial capacity of the underlying StringBuilder

StringBuilderWriter back to summary

StringBuilderWriter	back to summary
public StringBuilderWriter(final StringBuilder builder) Constructs a new instance with the specified `StringBuilder`. If `builder` is null a new instance with default capacity will be created. Parameters builder:StringBuilder The String builder. May be null.

public StringBuilderWriter(final StringBuilder builder)

Constructs a new instance with the specified StringBuilder.

If builder is null a new instance with default capacity will be created.

Parameters

builder:StringBuilder: The String builder. May be null.

Method Detail

append	back to summary
public Writer append(final char value) Overrides java.io.Writer.append. Implements java.lang.Appendable.append. Appends a single character to this Writer. Parameters value:char The character to append Returns:Writer This writer instance Annotations @Override

append

back to summary

public Writer append(final char value)

Overrides java.io.Writer.append.

Implements java.lang.Appendable.append.

Appends a single character to this Writer.

Parameters

value:char: The character to append

Returns:Writer

This writer instance

Annotations

@Override

append	back to summary
public Writer append(final CharSequence value) Overrides java.io.Writer.append. Implements java.lang.Appendable.append. Appends a character sequence to this Writer. Parameters value:CharSequence The character to append Returns:Writer This writer instance Annotations @Override

append

back to summary

public Writer append(final CharSequence value)

Overrides java.io.Writer.append.

Implements java.lang.Appendable.append.

Appends a character sequence to this Writer.

Parameters

value:CharSequence: The character to append

Returns:Writer

This writer instance

Annotations

@Override

append back to summary

append	back to summary
public Writer append(final CharSequence value, final int start, final int end) Overrides java.io.Writer.append. Implements java.lang.Appendable.append. Appends a portion of a character sequence to the `StringBuilder`. Parameters value:CharSequence The character to append start:int The index of the first character end:int The index of the last character + 1 Returns:Writer This writer instance Annotations @Override

public Writer append(final CharSequence value, final int start, final int end)

Overrides java.io.Writer.append.

Implements java.lang.Appendable.append.

Appends a portion of a character sequence to the StringBuilder.

Parameters

value:CharSequence: The character to append
start:int: The index of the first character
end:int: The index of the last character + 1

Returns:Writer

This writer instance

Annotations

@Override

close	back to summary
public void close() Implements abstract java.io.Writer.close. Implements java.io.Closeable.close. Closing this writer has no effect. Annotations @Override

back to summary

public void close()

Implements abstract java.io.Writer.close.

Implements java.io.Closeable.close.

Closing this writer has no effect.

Annotations

@Override

flush	back to summary
public void flush() Implements abstract java.io.Writer.flush. Implements java.io.Flushable.flush. Flushing this writer has no effect. Annotations @Override

flush

back to summary

public void flush()

Implements abstract java.io.Writer.flush.

Implements java.io.Flushable.flush.

Flushing this writer has no effect.

Annotations

@Override

getBuilder	back to summary
public StringBuilder getBuilder() Returns the underlying builder. Returns:StringBuilder The underlying builder

getBuilder

back to summary

public StringBuilder getBuilder()

Returns the underlying builder.

Returns:StringBuilder: The underlying builder

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Returns `StringBuilder#toString()`. Returns:String The contents of the String builder. Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Returns StringBuilder#toString().

Returns:String

The contents of the String builder.

Annotations

@Override

write back to summary

write	back to summary
public void write(final String value) Overrides java.io.Writer.write. Writes a String to the `StringBuilder`. Parameters value:String The value to write Annotations @Override

public void write(final String value)

Overrides java.io.Writer.write.

Writes a String to the StringBuilder.

Parameters

value:String: The value to write

Annotations

@Override

write back to summary

write	back to summary
public void write(final char[] value, final int offset, final int length) Implements abstract java.io.Writer.write. Writes a portion of a character array to the `StringBuilder`. Parameters value:char[] The value to write offset:int The index of the first character length:int The number of characters to write Annotations @Override

public void write(final char[] value, final int offset, final int length)

Implements abstract java.io.Writer.write.

Writes a portion of a character array to the StringBuilder.

Parameters

value:char[]: The value to write
offset:int: The index of the first character
length:int: The number of characters to write

Annotations

@Override

public Class StringBuilderWriter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail