Modifier and Type	Class and Description
public static class	StyleContext.StyleContextBuilder Builder for `StyleContext`.

Access	Constructor and Description
pack-priv	StyleContext(StyleContext.StyleContextBuilder builder)
pack-priv	StyleContext()

Method Summary

Modifier and Type	Method and Description
public static StyleContext.StyleContextBuilder	Returns: a new `StyleContextBuilder` builder() Returns a new builder for constructing a `StyleContext`.
public boolean	equals(Object o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public static StyleContext	Returns: a new `StyleContext` containing the given styles from(Map<String, AnsiCode> a map of markup names to ANSI codes; must not be `null` codes) Creates a `StyleContext` from an existing map of style names to `AnsiCode` instances.
public static StyleContext	Returns: a new `StyleContext` containing the same styles from(StyleContext the context to copy; must not be `null` context) Creates a shallow copy of an existing `StyleContext`.
public static StyleContext	Returns: a new `StyleContext` containing the same styles fromTheme(String the name of the theme to be registered; must not be `null` theme) Creates a `StyleContext` from a CliqueTheme.
public AnsiCode	Returns: the associated `AnsiCode`, or `null` if not present get(String the markup name to look up s) Returns the `AnsiCode` registered under the given markup name, or `null` if no style is registered for that name.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

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

Field Detail

localStyles	back to summary
private final Map<String, AnsiCode> localStyles

NONE back to summary

NONE	back to summary
public static final StyleContext NONE A sentinel `StyleContext` with no registered styles. Passing this to `ParserConfiguration.ParserConfigurationBuilder#styleContext(StyleContext)` is a no-op; no local styles will be added to the parser's resolution chain.

public static final StyleContext NONE

A sentinel StyleContext with no registered styles.

Passing this to ParserConfiguration.ParserConfigurationBuilder#styleContext(StyleContext) is a no-op; no local styles will be added to the parser's resolution chain.

StyleContext	back to summary
pack-priv StyleContext(StyleContext.StyleContextBuilder builder)

StyleContext	back to summary
pack-priv StyleContext()

Method Detail

builder back to summary

builder	back to summary
public static StyleContext.StyleContextBuilder builder() Returns a new builder for constructing a `StyleContext`. Returns:StyleContext.StyleContextBuilder a new `StyleContextBuilder`

public static StyleContext.StyleContextBuilder builder()

Returns a new builder for constructing a StyleContext.

Returns:StyleContext.StyleContextBuilder: a new StyleContextBuilder

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

from back to summary

from	back to summary
public static StyleContext from(Map<String, AnsiCode> codes) Creates a `StyleContext` from an existing map of style names to `AnsiCode` instances. The provided map is copied; subsequent modifications to it do not affect the returned context. Parameters codes:Map<String, AnsiCode> a map of markup names to ANSI codes; must not be `null` Returns:StyleContext a new `StyleContext` containing the given styles Exceptions NullPointerException: if `codes` is `null`

public static StyleContext from(Map<String, AnsiCode> codes)

Creates a StyleContext from an existing map of style names to AnsiCode instances.

The provided map is copied; subsequent modifications to it do not affect the returned context.

Parameters

codes:Map<String, AnsiCode>: a map of markup names to ANSI codes; must not be null

Returns:StyleContext

a new StyleContext containing the given styles

Exceptions

NullPointerException:: if codes is null

from back to summary

from	back to summary
public static StyleContext from(StyleContext context) Creates a shallow copy of an existing `StyleContext`. The registered styles are copied; the returned context is independent of the source. Parameters context:StyleContext the context to copy; must not be `null` Returns:StyleContext a new `StyleContext` containing the same styles Exceptions NullPointerException: if `context` is `null`

public static StyleContext from(StyleContext context)

Creates a shallow copy of an existing StyleContext.

The registered styles are copied; the returned context is independent of the source.

Parameters

context:StyleContext: the context to copy; must not be null

Returns:StyleContext

a new StyleContext containing the same styles

Exceptions

NullPointerException:: if context is null

fromTheme back to summary

fromTheme	back to summary
public static StyleContext fromTheme(String theme) Creates a `StyleContext` from a CliqueTheme. The registered styles are copied; the returned context is independent of the source. Parameters theme:String the name of the theme to be registered; must not be `null` Returns:StyleContext a new `StyleContext` containing the same styles Exceptions NullPointerException: if `theme` is `null` NoSuchThemeException: if no theme was found

public static StyleContext fromTheme(String theme)

Creates a StyleContext from a CliqueTheme.

The registered styles are copied; the returned context is independent of the source.

Parameters

theme:String: the name of the theme to be registered; must not be null

Returns:StyleContext

a new StyleContext containing the same styles

Exceptions

NullPointerException:: if theme is null
NoSuchThemeException:: if no theme was found

get back to summary

get	back to summary
public AnsiCode get(String s) Returns the `AnsiCode` registered under the given markup name, or `null` if no style is registered for that name. Parameters s:String the markup name to look up Returns:AnsiCode the associated `AnsiCode`, or `null` if not present

public AnsiCode get(String s)

Returns the AnsiCode registered under the given markup name, or null if no style is registered for that name.

Parameters

s:String: the markup name to look up

Returns:AnsiCode

the associated AnsiCode, or null if not present

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

toString back to summary

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

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

io.github.kusoroadeolu.clique.configuration back to summary

public Class StyleContext.StyleContextBuilder

Class Inheritance

extends Object

java.lang.Object
io.github.kusoroadeolu.clique.configuration.StyleContext.StyleContextBuilder

Builder for StyleContext.

Multiple add calls accumulate; later registrations for the same markup name overwrite earlier ones. All overloads ultimately store a single AnsiCode per name — multi-code overloads wrap their arguments in a CompositeColor.

This builder is not thread-safe.

Field Summary

Modifier and Type	Field and Description
private final Map<String, AnsiCode>	localStyles
private static final String	NULL_STYLE_NAME

Constructor Summary

Access	Constructor and Description
private	StyleContextBuilder()

Method Summary

Modifier and Type	Method and Description
public StyleContext.StyleContextBuilder	Returns: this builder add(String the markup name; must not be `null` style, AnsiCode the ANSI code to associate; must not be `null` code) Registers a single `AnsiCode` under the given markup name.
public StyleContext.StyleContextBuilder	Returns: this builder add(String the markup name; must not be `null` style, AnsiCode... one or more ANSI codes to combine; must not be `null` code) Registers multiple `AnsiCode` instances under the given markup name, combining them into a `CompositeColor`.
public StyleContext.StyleContextBuilder	Returns: this builder add(String the markup name; must not be `null` style, Collection<AnsiCode> a collection of ANSI codes to combine; must not be `null` code) Registers a collection of `AnsiCode` instances under the given markup name, combining them into a `CompositeColor`.
public StyleContext.StyleContextBuilder	Returns: this builder add(Map<String, AnsiCode> a map of markup names to ANSI codes; must not be `null` codes) Bulk-registers all entries from the given map.
public StyleContext.StyleContextBuilder	Returns: this builder add(StyleContext the context whose styles to merge; must not be `null` context) Merges all styles from an existing `StyleContext` into this builder.
public StyleContext	Returns: a new, immutable `StyleContext` build() Constructs a new `StyleContext` from the current builder state.

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

Field Detail

localStyles	back to summary
private final Map<String, AnsiCode> localStyles

NULL_STYLE_NAME	back to summary
private static final String NULL_STYLE_NAME

Constructor Detail

StyleContextBuilder	back to summary
private StyleContextBuilder()

Method Detail

add back to summary

add	back to summary
public StyleContext.StyleContextBuilder add(String style, AnsiCode code) Registers a single `AnsiCode` under the given markup name. Parameters style:String the markup name; must not be `null` code:AnsiCode the ANSI code to associate; must not be `null` Returns:StyleContext.StyleContextBuilder this builder Exceptions NullPointerException: if `style` or `code` is `null`

public StyleContext.StyleContextBuilder add(String style, AnsiCode code)

Registers a single AnsiCode under the given markup name.

Parameters

style:String: the markup name; must not be null
code:AnsiCode: the ANSI code to associate; must not be null

Returns:StyleContext.StyleContextBuilder

this builder

Exceptions

NullPointerException:: if style or code is null

add back to summary

add	back to summary
public StyleContext.StyleContextBuilder add(String style, AnsiCode... code) Registers multiple `AnsiCode` instances under the given markup name, combining them into a `CompositeColor`. Parameters style:String the markup name; must not be `null` code:AnsiCode[] one or more ANSI codes to combine; must not be `null` Returns:StyleContext.StyleContextBuilder this builder Exceptions NullPointerException: if `style` or `code` is `null`

public StyleContext.StyleContextBuilder add(String style, AnsiCode... code)

Registers multiple AnsiCode instances under the given markup name, combining them into a CompositeColor.

Parameters

style:String: the markup name; must not be null
code:AnsiCode[]: one or more ANSI codes to combine; must not be null

Returns:StyleContext.StyleContextBuilder

this builder

Exceptions

NullPointerException:: if style or code is null

add back to summary

add	back to summary
public StyleContext.StyleContextBuilder add(String style, Collection<AnsiCode> code) Registers a collection of `AnsiCode` instances under the given markup name, combining them into a `CompositeColor`. Parameters style:String the markup name; must not be `null` code:Collection<AnsiCode> a collection of ANSI codes to combine; must not be `null` Returns:StyleContext.StyleContextBuilder this builder Exceptions NullPointerException: if `style` or `code` is `null`

public StyleContext.StyleContextBuilder add(String style, Collection<AnsiCode> code)

Registers a collection of AnsiCode instances under the given markup name, combining them into a CompositeColor.

Parameters

style:String: the markup name; must not be null
code:Collection<AnsiCode>: a collection of ANSI codes to combine; must not be null

Returns:StyleContext.StyleContextBuilder

this builder

Exceptions

NullPointerException:: if style or code is null

add back to summary

add	back to summary
public StyleContext.StyleContextBuilder add(Map<String, AnsiCode> codes) Bulk-registers all entries from the given map. Entries are added in iteration order; if the map contains a name already registered in this builder, the map's value overwrites the existing one. Parameters codes:Map<String, AnsiCode> a map of markup names to ANSI codes; must not be `null` Returns:StyleContext.StyleContextBuilder this builder Exceptions NullPointerException: if `codes` is `null`

public StyleContext.StyleContextBuilder add(Map<String, AnsiCode> codes)

Bulk-registers all entries from the given map.

Entries are added in iteration order; if the map contains a name already registered in this builder, the map's value overwrites the existing one.

Parameters

codes:Map<String, AnsiCode>: a map of markup names to ANSI codes; must not be null

Returns:StyleContext.StyleContextBuilder

this builder

Exceptions

NullPointerException:: if codes is null

add back to summary

add	back to summary
public StyleContext.StyleContextBuilder add(StyleContext context) Merges all styles from an existing `StyleContext` into this builder. If a name from `context` is already registered in this builder, the incoming value overwrites the existing one. Parameters context:StyleContext the context whose styles to merge; must not be `null` Returns:StyleContext.StyleContextBuilder this builder Exceptions NullPointerException: if `context` is `null`

public StyleContext.StyleContextBuilder add(StyleContext context)

Merges all styles from an existing StyleContext into this builder.

If a name from context is already registered in this builder, the incoming value overwrites the existing one.

Parameters

context:StyleContext: the context whose styles to merge; must not be null

Returns:StyleContext.StyleContextBuilder

this builder

Exceptions

NullPointerException:: if context is null

build back to summary

build	back to summary
public StyleContext build() Constructs a new `StyleContext` from the current builder state. Returns:StyleContext a new, immutable `StyleContext`

public StyleContext build()

Constructs a new StyleContext from the current builder state.

Returns:StyleContext: a new, immutable StyleContext

public final Class StyleContext

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class StyleContext.StyleContextBuilder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

Modifier and Type	Field and Description
private final Map<String, AnsiCode>	localStyles
public static final StyleContext	NONE A sentinel `StyleContext` with no registered styles.