Package software.amazon.smithy.cli

Class ColorFormatter.PrinterBuffer

java.lang.Object

software.amazon.smithy.cli.ColorFormatter.PrinterBuffer

All Implemented Interfaces:

Appendable, AutoCloseable

Enclosing interface:

ColorFormatter

public static final class ColorFormatter.PrinterBuffer
extends Object
implements Appendable, AutoCloseable

A buffer associated with a CliPrinter used to build up a string of colored text.

Use close() to write to the associated CliPrinter, or wrap the buffer in a try-with-resources block.

Method Summary

Modifier and Type	Method	Description
ColorFormatter.PrinterBuffer	append(char c)
ColorFormatter.PrinterBuffer	append(CharSequence csq)
ColorFormatter.PrinterBuffer	append(CharSequence csq, int start, int end)
void	close()
ColorFormatter.PrinterBuffer	print(String text, Style... styles)	Writes styled text to the builder using the CliPrinter's color settings.
ColorFormatter.PrinterBuffer	println()	Writes a system-dependent new line.
ColorFormatter.PrinterBuffer	println(String text, Style... styles)	Prints a line of styled text to the buffer.
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

toString

public String toString()

Overrides:

toString in class Object

append

public ColorFormatter.PrinterBuffer append(CharSequence csq)

Specified by:

append in interface Appendable

append

public ColorFormatter.PrinterBuffer append(CharSequence csq,
 int start,
 int end)

Specified by:

append in interface Appendable

append

public ColorFormatter.PrinterBuffer append(char c)

Specified by:

append in interface Appendable

print

public ColorFormatter.PrinterBuffer print(String text,
 Style... styles)

Writes styled text to the builder using the CliPrinter's color settings.

Parameters:

text - Text to write.

styles - Styles to apply to the text.

Returns:

Returns self.

println

public ColorFormatter.PrinterBuffer println(String text,
 Style... styles)

Prints a line of styled text to the buffer.

Parameters:

text - Text to print.

styles - Styles to apply.

Returns:

Returns self.

println

public ColorFormatter.PrinterBuffer println()

Writes a system-dependent new line.

Returns:

Returns the buffer.

close

public void close()

Specified by:

close in interface AutoCloseable