Immutable configuration for a io.github.kusoroadeolu.clique.components.Tree.

Controls two aspects of tree rendering:

Connector color — the ANSI color applied to the connector characters (├─, └─, │) that link nodes in the rendered output. Node labels are not affected.
Parser — the MarkupParser used to resolve inline markup tags

The DEFAULT constant provides a pre-built configuration with no connector color and MarkupParser#DEFAULT as the parser.

This class is immutable and thread-safe. TreeConfigurationBuilder is not thread-safe; external synchronization is required if a builder instance is shared across threads.

Example:

TreeConfiguration config = TreeConfiguration.builder()
    .connectorColor("[cyan]")
    .parser(MarkupParser.NONE)
    .build();

Tree tree = new Tree("root", config);

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	TreeConfiguration.TreeConfigurationBuilder Builder for `TreeConfiguration`.

Field Summary

Modifier and Type	Field and Description
private final AnsiCode[]	connectorColor
public static final TreeConfiguration	DEFAULT A default `TreeConfiguration` with no connector color and `MarkupParser#DEFAULT` as the parser.
private final MarkupParser	parser

Access	Constructor and Description
private	TreeConfiguration()
private	TreeConfiguration(TreeConfiguration.TreeConfigurationBuilder builder)

Method Summary

Modifier and Type	Method and Description
public static TreeConfiguration.TreeConfigurationBuilder	Returns: a new `TreeConfigurationBuilder` builder() Returns a new builder for constructing a `TreeConfiguration`.
public boolean	equals(Object object) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public AnsiCode[]	Returns: a copy of the connector color codes; never `null`, may be empty getConnectorColor() Returns a copy of the ANSI codes applied to tree connector characters Returns an empty array if no connector color has been set.
public MarkupParser	Returns: the parser; never `null` getParser() Returns the `MarkupParser` used to resolve markup tags in node labels at render time.
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

connectorColor	back to summary
private final AnsiCode[] connectorColor

DEFAULT	back to summary
public static final TreeConfiguration DEFAULT A default `TreeConfiguration` with no connector color and `MarkupParser#DEFAULT` as the parser.

parser	back to summary
private final MarkupParser parser

Constructor Detail

TreeConfiguration	back to summary
private TreeConfiguration()

TreeConfiguration	back to summary
private TreeConfiguration(TreeConfiguration.TreeConfigurationBuilder builder)

Method Detail

builder back to summary

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

public static TreeConfiguration.TreeConfigurationBuilder builder()

Returns a new builder for constructing a TreeConfiguration.

Returns:TreeConfiguration.TreeConfigurationBuilder: a new TreeConfigurationBuilder

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

getConnectorColor back to summary

getConnectorColor	back to summary
public AnsiCode[] getConnectorColor() Returns a copy of the ANSI codes applied to tree connector characters Returns an empty array if no connector color has been set. A defensive copy is returned on each call. Returns:AnsiCode[] a copy of the connector color codes; never `null`, may be empty

public AnsiCode[] getConnectorColor()

Returns a copy of the ANSI codes applied to tree connector characters

Returns an empty array if no connector color has been set. A defensive copy is returned on each call.

Returns:AnsiCode[]: a copy of the connector color codes; never null, may be empty

getParser back to summary

getParser	back to summary
public MarkupParser getParser() Returns the `MarkupParser` used to resolve markup tags in node labels at render time. Returns:MarkupParser the parser; never `null`

public MarkupParser getParser()

Returns the MarkupParser used to resolve markup tags in node labels at render time.

Returns:MarkupParser: the parser; never null

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 TreeConfiguration.TreeConfigurationBuilder

Class Inheritance

extends Object

java.lang.Object
io.github.kusoroadeolu.clique.configuration.TreeConfiguration.TreeConfigurationBuilder

Builder for TreeConfiguration.

Default values match those of TreeConfiguration#DEFAULT. Methods may be called in any order; each returns this for chaining.

This builder is not thread-safe.

Field Summary

Modifier and Type	Field and Description
private AnsiCode[]	connectorColor
private MarkupParser	parser

Constructor Summary

Access	Constructor and Description
public	TreeConfigurationBuilder()

Method Summary

Modifier and Type	Method and Description
public TreeConfiguration	Returns: a new, immutable `TreeConfiguration` build() Constructs a new `TreeConfiguration` from the current builder state.
public TreeConfiguration.TreeConfigurationBuilder	Returns: this builder connectorColor(AnsiCode... one or more ANSI codes to apply to connectors; must not be `null` connectorColor) Sets the ANSI color applied to tree connector characters (`├─`, `└─`, `│`) during rendering.
public TreeConfiguration.TreeConfigurationBuilder	Returns: this builder connectorColor(String a markup string representing the desired connector color; must not be `null` connectorColor) Sets the connector color by parsing a markup string using the currently configured parser.
public TreeConfiguration.TreeConfigurationBuilder	Returns: this builder parser(MarkupParser the parser to use; must not be `null` parser) Sets the `MarkupParser` used to resolve markup tags in node labels.

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

Field Detail

connectorColor	back to summary
private AnsiCode[] connectorColor

parser	back to summary
private MarkupParser parser

Constructor Detail

TreeConfigurationBuilder	back to summary
public TreeConfigurationBuilder()

Method Detail

build back to summary

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

public TreeConfiguration build()

Constructs a new TreeConfiguration from the current builder state.

Returns:TreeConfiguration: a new, immutable TreeConfiguration

connectorColor back to summary

connectorColor	back to summary
public TreeConfiguration.TreeConfigurationBuilder connectorColor(AnsiCode... connectorColor) Sets the ANSI color applied to tree connector characters (`├─`, `└─`, `│`) during rendering. Node labels are not affected. Parameters connectorColor:AnsiCode[] one or more ANSI codes to apply to connectors; must not be `null` Returns:TreeConfiguration.TreeConfigurationBuilder this builder Exceptions NullPointerException: if `connectorColor` is `null`

public TreeConfiguration.TreeConfigurationBuilder connectorColor(AnsiCode... connectorColor)

Sets the ANSI color applied to tree connector characters (├─, └─, │) during rendering. Node labels are not affected.

Parameters

connectorColor:AnsiCode[]: one or more ANSI codes to apply to connectors; must not be null

Returns:TreeConfiguration.TreeConfigurationBuilder

this builder

Exceptions

NullPointerException:: if connectorColor is null

connectorColor back to summary

connectorColor	back to summary
public TreeConfiguration.TreeConfigurationBuilder connectorColor(String connectorColor) Sets the connector color by parsing a markup string using the currently configured parser. The markup string is resolved against the parser set via `parser(MarkupParser)` at the time this method is called. Equivalent to `connectorColor(ParserUtils.getAnsiCodes(connectorColor, parser))`. Parameters connectorColor:String a markup string representing the desired connector color; must not be `null` Returns:TreeConfiguration.TreeConfigurationBuilder this builder

public TreeConfiguration.TreeConfigurationBuilder connectorColor(String connectorColor)

Sets the connector color by parsing a markup string using the currently configured parser.

The markup string is resolved against the parser set via parser(MarkupParser) at the time this method is called.

Equivalent to connectorColor(ParserUtils.getAnsiCodes(connectorColor, parser)).

Parameters

connectorColor:String: a markup string representing the desired connector color; must not be null

Returns:TreeConfiguration.TreeConfigurationBuilder

this builder

parser back to summary

parser	back to summary
public TreeConfiguration.TreeConfigurationBuilder parser(MarkupParser parser) Sets the `MarkupParser` used to resolve markup tags in node labels. then be rendered as-is. Also affects subsequent calls to `connectorColor(String)`, which resolves color markup using this parser. Parameters parser:MarkupParser the parser to use; must not be `null` Returns:TreeConfiguration.TreeConfigurationBuilder this builder Exceptions NullPointerException: if `parser` is `null`

public TreeConfiguration.TreeConfigurationBuilder parser(MarkupParser parser)

Sets the MarkupParser used to resolve markup tags in node labels. then be rendered as-is. Also affects subsequent calls to connectorColor(String), which resolves color markup using this parser.

Parameters

parser:MarkupParser: the parser to use; must not be null

Returns:TreeConfiguration.TreeConfigurationBuilder

this builder

Exceptions

NullPointerException:: if parser is null

public final Class TreeConfiguration

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class TreeConfiguration.TreeConfigurationBuilder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail