Package org.pkl.core.util

Class AnsiStringBuilder

java.lang.Object

org.pkl.core.util.AnsiStringBuilder

public final class AnsiStringBuilder
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	AnsiStringBuilder.AnsiCode

Constructor Summary

Constructors

Constructor	Description
AnsiStringBuilder(boolean usingColor)

Method Summary

Modifier and Type	Method	Description
AnsiStringBuilder	append(char value)	Append the string representation of value to the string.
AnsiStringBuilder	append(int value)	Append the string representation of value to the string.
AnsiStringBuilder	append(Object value)	Append the string representation of value to the string.
AnsiStringBuilder	append(String value)	Append value to the string.
AnsiStringBuilder	append(EnumSet<AnsiStringBuilder.AnsiCode> codes, Runnable runnable)
AnsiStringBuilder	append(Set<AnsiStringBuilder.AnsiCode> codes, String value)	Append value to the string, ensuring it is formatted with codes.
AnsiStringBuilder	append(AnsiStringBuilder.AnsiCode code, int value)	Append value to the string, ensuring it is formatted with codes.
AnsiStringBuilder	append(AnsiStringBuilder.AnsiCode code, Runnable runnable)	Apply code to every appended element within runnable.
AnsiStringBuilder	append(AnsiStringBuilder.AnsiCode code, String value)	Append value to the string, ensuring it is formatted with codes.
AnsiStringBuilder	appendSandboxed(Runnable runnable)	Provides a runnable where anything appended is not affected by the existing context.
AnsiStringBuilder	appendUntrusted(String value)	Append a string whose contents are unknown, and might contain ANSI color codes.
int	length()
AnsiStringBuilder	newInstance()	Returns a fresh instance of this string builder.
void	setLength(int length)
PrintWriter	toPrintWriter()
String	toString()	Builds the data represented by this builder into a String.

Methods inherited from class java.lang.Object

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

Constructor Details

AnsiStringBuilder

public AnsiStringBuilder(boolean usingColor)

Method Details

append

public AnsiStringBuilder append(Set<AnsiStringBuilder.AnsiCode> codes,
 String value)

Append value to the string, ensuring it is formatted with codes.

append

public AnsiStringBuilder append(AnsiStringBuilder.AnsiCode code,
 int value)

Append value to the string, ensuring it is formatted with codes.

append

public AnsiStringBuilder append(AnsiStringBuilder.AnsiCode code,
 String value)

Append value to the string, ensuring it is formatted with codes.

append

public AnsiStringBuilder append(AnsiStringBuilder.AnsiCode code,
 Runnable runnable)

Apply code to every appended element within runnable.

This is a helper method. With this:

• There is no need to repeat the same style for multiple appends in a row.
• The parent style is added to any styles added applied in the children.

  For example, in the following snippet, "hello" is formatted in both bold and red:

  
   var sb = new AnsiCodingStringBuilder(true);
   sb.append(AnsiCode.RED, () -> {
     sb.append(AnsiCode.BOLD, "hello");
   });
  
   

append

public AnsiStringBuilder append(EnumSet<AnsiStringBuilder.AnsiCode> codes,
 Runnable runnable)

appendSandboxed

public AnsiStringBuilder appendSandboxed(Runnable runnable)

Provides a runnable where anything appended is not affected by the existing context.

appendUntrusted

public AnsiStringBuilder appendUntrusted(String value)

Append a string whose contents are unknown, and might contain ANSI color codes.

Always add a reset and re-apply all colors after appending the string.

append

public AnsiStringBuilder append(String value)

Append value to the string.

If called within append(AnsiCode, Runnable), applies any styles in the current context.

append

public AnsiStringBuilder append(char value)

Append the string representation of value to the string.

If called within append(AnsiCode, Runnable), applies any styles in the current context.

append

public AnsiStringBuilder append(int value)

Append the string representation of value to the string.

If called within append(AnsiCode, Runnable), applies any styles in the current context.

append

public AnsiStringBuilder append(Object value)

Append the string representation of value to the string.

If called within append(AnsiCode, Runnable), applies any styles in the current context.

newInstance

public AnsiStringBuilder newInstance()

Returns a fresh instance of this string builder.

toPrintWriter

public PrintWriter toPrintWriter()

length

public int length()

setLength

public void setLength(int length)

toString

public String toString()

Builds the data represented by this builder into a String.

Overrides:

toString in class Object