Clique 4.0.3 · io.github.kusoroadeolu.clique.style.StyleBuilder

Modifier and Type	Field and Description
private static final AnsiCode	RESET
private final StringBuilder	textBuilder

Access	Constructor and Description
public	StyleBuilder()

Method Summary

Modifier and Type	Method and Description
public StyleBuilder	Returns: this builder append(String the text to style text, AnsiCode... the ANSI codes to apply ansiCodes) Appends styled text to this builder without resetting the terminal.
public StyleBuilder	Returns: An instance of this appendAndReset(String The text we're applying the ansiCode to text, AnsiCode... The ANSI code we're applying to the text ansiCodes) Appends an ANSI code to this text and then resets the terminal
public boolean	equals(Object object) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public void	print(PrintStream the stream to print to stream) Prints the accumulated styled string to the given stream.
public void	print() Prints the accumulated styled string to `System.out`.
public String	Returns: the styled string toString() Overrides java.lang.Object.toString. Returns the accumulated styled string.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

RESET	back to summary
private static final AnsiCode RESET

textBuilder	back to summary
private final StringBuilder textBuilder

StyleBuilder	back to summary
public StyleBuilder()

Method Detail

append	back to summary
public StyleBuilder append(String text, AnsiCode... ansiCodes) Appends styled text to this builder without resetting the terminal. Styles accumulate across subsequent calls. Parameters text:String the text to style ansiCodes:AnsiCode[] the ANSI codes to apply Returns:StyleBuilder this builder

append

back to summary

public StyleBuilder append(String text, AnsiCode... ansiCodes)

Appends styled text to this builder without resetting the terminal. Styles accumulate across subsequent calls.

Parameters

text:String: the text to style
ansiCodes:AnsiCode[]: the ANSI codes to apply

Returns:StyleBuilder

this builder

appendAndReset	back to summary
public StyleBuilder appendAndReset(String text, AnsiCode... ansiCodes) Appends an ANSI code to this text and then resets the terminal Parameters text:String The text we're applying the ansiCode to ansiCodes:AnsiCode[] The ANSI code we're applying to the text Returns:StyleBuilder An instance of this

appendAndReset

back to summary

public StyleBuilder appendAndReset(String text, AnsiCode... ansiCodes)

Appends an ANSI code to this text and then resets the terminal

Parameters

text:String: The text we're applying the ansiCode to
ansiCodes:AnsiCode[]: The ANSI code we're applying to the text

Returns:StyleBuilder

An instance of this

equals back to summary

equals	back to summary
public boolean equals(Object object) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Annotations @Override

public boolean equals(Object object)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Annotations

@Override

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Annotations

@Override

print back to summary

print	back to summary
public void print(PrintStream stream) Prints the accumulated styled string to the given stream. Parameters stream:PrintStream the stream to print to Exceptions NullPointerException: if `stream` is null

public void print(PrintStream stream)

Prints the accumulated styled string to the given stream.

Parameters

stream:PrintStream: the stream to print to

Exceptions

NullPointerException:: if stream is null

print	back to summary
public void print() Prints the accumulated styled string to `System.out`.

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Returns the accumulated styled string. Returns:String the styled string

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Returns the accumulated styled string.

Returns:String: the styled string

public final Class StyleBuilder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail