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

Modifier and Type	Field and Description
private final List<AnsiCode>	codes
private final StyleContext	context
private final Gradient	gradient
private final Hyperlink	hyperlink

Access	Constructor and Description
public	Ink()
public	Ink(StyleContext context)
pack-priv	Ink(List<AnsiCode> codes, StyleContext context)
pack-priv	Ink(List<AnsiCode> codes, StyleContext context, Hyperlink hyperLink, Gradient gradient)

Method Summary

Modifier and Type	Method and Description
public Ink	bgBlack()
public Ink	bgBlue()
public Ink	bgCyan()
public Ink	bgGreen()
public Ink	Returns: a new `Ink` instance with the hex color accumulated bgHex(String the hex color string; must not be `null` and must be in `#RRGGBB` format hexCode) Applies a background hex color to this `Ink` instance.
public Ink	bgMagenta()
public Ink	bgRed()
public Ink	bgRgb(int red, int green, int blue)
public Ink	bgWhite()
public Ink	bgYellow()
public Ink	black()
public Ink	blue()
public Ink	bold()
public Ink	brightBgBlack()
public Ink	brightBgBlue()
public Ink	brightBgCyan()
public Ink	brightBgGreen()
public Ink	brightBgMagenta()
public Ink	brightBgRed()
public Ink	brightBgWhite()
public Ink	brightBgYellow()
public Ink	brightBlack()
public Ink	brightBlue()
public Ink	brightCyan()
public Ink	brightGreen()
public Ink	brightMagenta()
public Ink	brightRed()
public Ink	brightWhite()
public Ink	brightYellow()
public Ink	cyan()
public Ink	dim()
public Ink	doubleUnderline()
public boolean	equals(Object o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public Ink	Returns: a new `Ink` instance with the gradient accumulated gradient(RGBAnsiCode the starting `RGBAnsiCode` of the gradient; must not be `null` from, RGBAnsiCode the ending `RGBAnsiCode` of the gradient; must not be `null` to) Applies a color gradient to this `Ink` instance, transitioning from one `RGBAnsiCode` to another across the rendered text.
public Ink	Returns: a new `Ink` instance with the gradient accumulated gradient(String the starting hexCode of the gradient; must not be `null` fromHex, String the ending hexCode of the gradient; must not be `null` toHex) Applies a color gradient to this `Ink` instance, transitioning from one hex code to another across the rendered text.
public Ink	green()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public Ink	Returns: a new `Ink` instance with the hex color accumulated hex(String the hex color string; must not be `null` and must be in `#RRGGBB` format hexCode) Applies a foreground hex color to this `Ink` instance.
public Ink	Returns: a new `Ink` instance with the hyperlink accumulated hyperlink(String the URL to link to; must not be `null` url) Applies a hyperlink to this `Ink` instance using the given URL.
public Ink	invisible()
public Ink	italic()
public Ink	magenta()
public Ink	Returns: a new `Ink` instance with the style accumulated of(String the registered style name (e.g. `"ctp_mauve"`) style) Adds a named style, looked up from the instance's `StyleContext` and `PredefinedStyleContext`.
public Ink	Returns: a new `Ink` instance with the style accumulated of(AnsiCode the AnsiCode to be applied code) Adds a named style, looked up from the instance's `StyleContext` and `PredefinedStyleContext`.
public String	Returns: the styled string with ANSI sequences applied, or just the raw String if no styles were accumulated on(String the String to style; value) Applies the accumulated ANSI codes to the given value and returns the styled string.
public String	Returns: the styled string with ANSI sequences applied, or just `value.toString()` if no styles were accumulated on(Object the Object to style; `toString()` is called on it value) Applies the accumulated ANSI codes to the given value and returns the styled string.
public Ink	red()
public Ink	reverseVideo()
public Ink	rgb(int red, int green, int blue)
public Ink	strikethrough()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public Ink	underline()
public Ink	white()
private Ink	with(AnsiCode code)
private Ink	with(Hyperlink hyperlink)
private Ink	with(Gradient gradient)
public Ink	yellow()

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

codes	back to summary
private final List<AnsiCode> codes

context	back to summary
private final StyleContext context

gradient	back to summary
private final Gradient gradient

hyperlink	back to summary
private final Hyperlink hyperlink

Ink	back to summary
public Ink()

Ink	back to summary
public Ink(StyleContext context)

Ink	back to summary
pack-priv Ink(List<AnsiCode> codes, StyleContext context)

Ink	back to summary
pack-priv Ink(List<AnsiCode> codes, StyleContext context, Hyperlink hyperLink, Gradient gradient)

Method Detail

bgBlack	back to summary
public Ink bgBlack()

bgBlue	back to summary
public Ink bgBlue()

bgCyan	back to summary
public Ink bgCyan()

bgGreen	back to summary
public Ink bgGreen()

bgHex back to summary

bgHex	back to summary
public Ink bgHex(String hexCode) Applies a background hex color to this `Ink` instance. The hex string must be in `#RRGGBB` format. The value is parsed into an `RGBColor` and applied to the rendered text. Parameters hexCode:String the hex color string; must not be `null` and must be in `#RRGGBB` format Returns:Ink a new `Ink` instance with the hex color accumulated Exceptions NullPointerException: if `hexCode` is `null` IllegalArgumentException: if `hexCode` is not in `#RRGGBB` format

public Ink bgHex(String hexCode)

Applies a background hex color to this Ink instance.

The hex string must be in #RRGGBB format. The value is parsed into an RGBColor and applied to the rendered text.

Parameters

hexCode:String: the hex color string; must not be null and must be in #RRGGBB format

Returns:Ink

a new Ink instance with the hex color accumulated

Exceptions

NullPointerException:: if hexCode is null
IllegalArgumentException:: if hexCode is not in #RRGGBB format

bgMagenta	back to summary
public Ink bgMagenta()

bgRed	back to summary
public Ink bgRed()

bgRgb	back to summary
public Ink bgRgb(int red, int green, int blue)

bgWhite	back to summary
public Ink bgWhite()

bgYellow	back to summary
public Ink bgYellow()

black	back to summary
public Ink black()

blue	back to summary
public Ink blue()

bold	back to summary
public Ink bold()

brightBgBlack	back to summary
public Ink brightBgBlack()

brightBgBlue	back to summary
public Ink brightBgBlue()

brightBgCyan	back to summary
public Ink brightBgCyan()

brightBgGreen	back to summary
public Ink brightBgGreen()

brightBgMagenta	back to summary
public Ink brightBgMagenta()

brightBgRed	back to summary
public Ink brightBgRed()

brightBgWhite	back to summary
public Ink brightBgWhite()

brightBgYellow	back to summary
public Ink brightBgYellow()

brightBlack	back to summary
public Ink brightBlack()

brightBlue	back to summary
public Ink brightBlue()

brightCyan	back to summary
public Ink brightCyan()

brightGreen	back to summary
public Ink brightGreen()

brightMagenta	back to summary
public Ink brightMagenta()

brightRed	back to summary
public Ink brightRed()

brightWhite	back to summary
public Ink brightWhite()

brightYellow	back to summary
public Ink brightYellow()

cyan	back to summary
public Ink cyan()

dim	back to summary
public Ink dim()

doubleUnderline	back to summary
public Ink doubleUnderline()

equals back to summary

equals	back to summary
public boolean equals(Object o) 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 o)

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

gradient back to summary

gradient	back to summary
public Ink gradient(RGBAnsiCode from, RGBAnsiCode to) Applies a color gradient to this `Ink` instance, transitioning from one `RGBAnsiCode` to another across the rendered text. The gradient is computed by linearly interpolating the R, G, and B channels between `from` and `to` across each visible character. Existing ANSI escape sequences embedded in the text are preserved and excluded from the interpolation; only printable characters are colorized. A `RESET` sequence is appended at the end of the output. Parameters from:RGBAnsiCode the starting `RGBAnsiCode` of the gradient; must not be `null` to:RGBAnsiCode the ending `RGBAnsiCode` of the gradient; must not be `null` Returns:Ink a new `Ink` instance with the gradient accumulated Exceptions NullPointerException: if `from` or `to` is `null`

public Ink gradient(RGBAnsiCode from, RGBAnsiCode to)

Applies a color gradient to this Ink instance, transitioning from one RGBAnsiCode to another across the rendered text.

The gradient is computed by linearly interpolating the R, G, and B channels between from and to across each visible character. Existing ANSI escape sequences embedded in the text are preserved and excluded from the interpolation; only printable characters are colorized. A RESET sequence is appended at the end of the output.

Parameters

from:RGBAnsiCode: the starting RGBAnsiCode of the gradient; must not be null
to:RGBAnsiCode: the ending RGBAnsiCode of the gradient; must not be null

Returns:Ink

a new Ink instance with the gradient accumulated

Exceptions

NullPointerException:: if from or to is null

gradient back to summary

gradient	back to summary
public Ink gradient(String fromHex, String toHex) Applies a color gradient to this `Ink` instance, transitioning from one hex code to another across the rendered text. The gradient is computed by linearly interpolating the R, G, and B channels between `fromHex` and `toHex` across each visible character. Existing ANSI escape sequences embedded in the text are preserved and excluded from the interpolation; only printable characters are colorized. A `RESET` sequence is appended at the end of the output. Parameters fromHex:String the starting hexCode of the gradient; must not be `null` toHex:String the ending hexCode of the gradient; must not be `null` Returns:Ink a new `Ink` instance with the gradient accumulated Exceptions NullPointerException: if `from` or `to` is `null`

public Ink gradient(String fromHex, String toHex)

Applies a color gradient to this Ink instance, transitioning from one hex code to another across the rendered text.

The gradient is computed by linearly interpolating the R, G, and B channels between fromHex and toHex across each visible character. Existing ANSI escape sequences embedded in the text are preserved and excluded from the interpolation; only printable characters are colorized. A RESET sequence is appended at the end of the output.

Parameters

fromHex:String: the starting hexCode of the gradient; must not be null
toHex:String: the ending hexCode of the gradient; must not be null

Returns:Ink

a new Ink instance with the gradient accumulated

Exceptions

NullPointerException:: if from or to is null

green	back to summary
public Ink green()

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

hex back to summary

hex	back to summary
public Ink hex(String hexCode) Applies a foreground hex color to this `Ink` instance. The hex string must be in `#RRGGBB` format. The value is parsed into an `RGBColor` and applied to the rendered text. Parameters hexCode:String the hex color string; must not be `null` and must be in `#RRGGBB` format Returns:Ink a new `Ink` instance with the hex color accumulated Exceptions NullPointerException: if `hexCode` is `null` IllegalArgumentException: if `hexCode` is not in `#RRGGBB` format

public Ink hex(String hexCode)

Applies a foreground hex color to this Ink instance.

The hex string must be in #RRGGBB format. The value is parsed into an RGBColor and applied to the rendered text.

Parameters

hexCode:String: the hex color string; must not be null and must be in #RRGGBB format

Returns:Ink

a new Ink instance with the hex color accumulated

Exceptions

NullPointerException:: if hexCode is null
IllegalArgumentException:: if hexCode is not in #RRGGBB format

hyperlink back to summary

hyperlink	back to summary
public Ink hyperlink(String url) Applies a hyperlink to this `Ink` instance using the given URL. The hyperlink wraps rendered text in OSC 8 ANSI escape sequences (`\033]8;;<url>\033\\<text>\033]8;;\033\\`), supported by most modern terminals. Parameters url:String the URL to link to; must not be `null` Returns:Ink a new `Ink` instance with the hyperlink accumulated Exceptions NullPointerException: if `url` is `null`

public Ink hyperlink(String url)

Applies a hyperlink to this Ink instance using the given URL. The hyperlink wraps rendered text in OSC 8 ANSI escape sequences (\033]8;;<url>\033\\<text>\033]8;;\033\\), supported by most modern terminals.

Parameters

url:String: the URL to link to; must not be null

Returns:Ink

a new Ink instance with the hyperlink accumulated

Exceptions

NullPointerException:: if url is null

invisible	back to summary
public Ink invisible()

italic	back to summary
public Ink italic()

magenta	back to summary
public Ink magenta()

of back to summary

public Ink of(String style)

Adds a named style, looked up from the instance's StyleContext and PredefinedStyleContext. Throws UndefinedStyleException if not found.

Parameters

style:String: the registered style name (e.g. "ctp_mauve")

Returns:Ink

a new Ink instance with the style accumulated

Exceptions

NullPointerException:: if style is null

of back to summary

public Ink of(AnsiCode code)

Adds a named style, looked up from the instance's StyleContext and PredefinedStyleContext. Throws UndefinedStyleException if not found.

Parameters

code:AnsiCode: the AnsiCode to be applied

Returns:Ink

a new Ink instance with the style accumulated

Exceptions

NullPointerException:: if style is null

back to summary

public String on(String value)

Applies the accumulated ANSI codes to the given value and returns the styled string. Appends a reset sequence at the end.

Parameters

value:String: the String to style;

Returns:String

the styled string with ANSI sequences applied, or just the raw String if no styles were accumulated

Exceptions

NullPointerException:: if value is null

on back to summary

public String on(Object value)

Applies the accumulated ANSI codes to the given value and returns the styled string. Appends a reset sequence at the end.

Parameters

value:Object: the Object to style; toString() is called on it

Returns:String

the styled string with ANSI sequences applied, or just value.toString() if no styles were accumulated

Exceptions

NullPointerException:: if value is null

red	back to summary
public Ink red()

reverseVideo	back to summary
public Ink reverseVideo()

rgb	back to summary
public Ink rgb(int red, int green, int blue)

strikethrough	back to summary
public Ink strikethrough()

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

underline	back to summary
public Ink underline()

white	back to summary
public Ink white()

with	back to summary
private Ink with(AnsiCode code)

with	back to summary
private Ink with(Hyperlink hyperlink)

with	back to summary
private Ink with(Gradient gradient)

yellow	back to summary
public Ink yellow()

public final Class Ink

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail