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

Controls three aspects of divider rendering:

Divider character — the character used to draw the horizontal line. Defaults to '─'.
Divider color — the ANSI color applied to the divider characters during rendering. Defaults to reset (no color).
Parser — the MarkupParser used to resolve inline markup tags in the divider title.

The DEFAULT constant provides a pre-built configuration with the default divider character, no divider color, and MarkupParser#DEFAULT as the parser.

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

Example:

DividerConfiguration config = DividerConfiguration.builder()
    .dividerChar('=')
    .dividerColor("red")
    .parser(MarkupParser.DEFAULT)
    .build();

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	DividerConfiguration.DividerConfigurationBuilder

Field Summary

Modifier and Type	Field and Description
public static final DividerConfiguration	DEFAULT
private final char	dividerChar
private final AnsiCode[]	dividerColor
private final MarkupParser	parser

Access	Constructor and Description
pack-priv	DividerConfiguration(DividerConfiguration.DividerConfigurationBuilder builder)
pack-priv	DividerConfiguration()
pack-priv	DividerConfiguration(AnsiCode[] dividerColor, char dividerChar, MarkupParser parser)

Method Summary

Modifier and Type	Method and Description
public static DividerConfiguration.DividerConfigurationBuilder	Returns: a new `DividerConfigurationBuilder` builder() Returns a new builder for constructing a `DividerConfiguration`.
public boolean	equals(Object o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public char	getDividerChar()
public AnsiCode[]	getDividerColor()
public MarkupParser	getParser()
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

DEFAULT	back to summary
public static final DividerConfiguration DEFAULT

dividerChar	back to summary
private final char dividerChar

dividerColor	back to summary
private final AnsiCode[] dividerColor

parser	back to summary
private final MarkupParser parser

DividerConfiguration	back to summary
pack-priv DividerConfiguration(DividerConfiguration.DividerConfigurationBuilder builder)

DividerConfiguration	back to summary
pack-priv DividerConfiguration()

DividerConfiguration	back to summary
pack-priv DividerConfiguration(AnsiCode[] dividerColor, char dividerChar, MarkupParser parser)

Method Detail

builder back to summary

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

public static DividerConfiguration.DividerConfigurationBuilder builder()

Returns a new builder for constructing a DividerConfiguration.

Returns:DividerConfiguration.DividerConfigurationBuilder: a new DividerConfigurationBuilder

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

getDividerChar	back to summary
public char getDividerChar()

getDividerColor	back to summary
public AnsiCode[] getDividerColor()

getParser	back to summary
public MarkupParser getParser()

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 DividerConfiguration.DividerConfigurationBuilder

Class Inheritance

extends Object

java.lang.Object
io.github.kusoroadeolu.clique.configuration.DividerConfiguration.DividerConfigurationBuilder

Field Summary

Modifier and Type	Field and Description
private char	dividerChar
private AnsiCode[]	dividerColor
private MarkupParser	parser

Constructor Summary

Access	Constructor and Description
public	DividerConfigurationBuilder()

Method Summary

Modifier and Type	Method and Description
public DividerConfiguration	Returns: a new, immutable `DividerConfiguration` build() Constructs a new `DividerConfiguration` from the current builder state.
public DividerConfiguration.DividerConfigurationBuilder	Returns: this builder dividerChar(char the char used to render the Divider c) Sets the char used to render the Divider
public DividerConfiguration.DividerConfigurationBuilder	Returns: this builder dividerColor(AnsiCode... one or more ANSI codes to apply to Divider; must not be `null` colorCodes) Sets the ANSI color to the `io.github.kusoroadeolu.clique.components.Divider` characters during rendering.
public DividerConfiguration.DividerConfigurationBuilder	Returns: this builder dividerColor(String a markup string representing the desired Divider color; must not be `null` color) Sets the ANSI color to the Divider by parsing a markup string using the currently configured parser.
public DividerConfiguration.DividerConfigurationBuilder	Returns: this builder parser(MarkupParser the parser to use; must not be `null` parser) Sets the `MarkupParser` used to resolve markup tags in the divider title.

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

Field Detail

dividerChar	back to summary
private char dividerChar

dividerColor	back to summary
private AnsiCode[] dividerColor

parser	back to summary
private MarkupParser parser

Constructor Detail

DividerConfigurationBuilder	back to summary
public DividerConfigurationBuilder()

Method Detail

build back to summary

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

public DividerConfiguration build()

Constructs a new DividerConfiguration from the current builder state.

Returns:DividerConfiguration: a new, immutable DividerConfiguration

dividerChar back to summary

dividerChar	back to summary
public DividerConfiguration.DividerConfigurationBuilder dividerChar(char c) Sets the char used to render the Divider Parameters c:char the char used to render the Divider Returns:DividerConfiguration.DividerConfigurationBuilder this builder Exceptions NullPointerException: if `c` is `null`

public DividerConfiguration.DividerConfigurationBuilder dividerChar(char c)

Sets the char used to render the Divider

Parameters

c:char: the char used to render the Divider

Returns:DividerConfiguration.DividerConfigurationBuilder

this builder

Exceptions

NullPointerException:: if c is null

dividerColor back to summary

dividerColor	back to summary
public DividerConfiguration.DividerConfigurationBuilder dividerColor(AnsiCode... colorCodes) Sets the ANSI color to the `io.github.kusoroadeolu.clique.components.Divider` characters during rendering. Parameters colorCodes:AnsiCode[] one or more ANSI codes to apply to Divider; must not be `null` Returns:DividerConfiguration.DividerConfigurationBuilder this builder Exceptions NullPointerException: if `codes` is `null`

public DividerConfiguration.DividerConfigurationBuilder dividerColor(AnsiCode... colorCodes)

Sets the ANSI color to the io.github.kusoroadeolu.clique.components.Divider characters during rendering.

Parameters

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

Returns:DividerConfiguration.DividerConfigurationBuilder

this builder

Exceptions

NullPointerException:: if codes is null

dividerColor back to summary

dividerColor	back to summary
public DividerConfiguration.DividerConfigurationBuilder dividerColor(String color) Sets the ANSI color to the Divider by parsing a markup string using the currently configured parser. to the `io.github.kusoroadeolu.clique.components.Divider` characters The markup string is resolved against the parser set via `parser(MarkupParser)` at the time this method is called. Parameters color:String a markup string representing the desired Divider color; must not be `null` Returns:DividerConfiguration.DividerConfigurationBuilder this builder Exceptions NullPointerException: if `color` is `null`

public DividerConfiguration.DividerConfigurationBuilder dividerColor(String color)

Sets the ANSI color to the Divider by parsing a markup string using the currently configured parser. to the io.github.kusoroadeolu.clique.components.Divider characters

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

Parameters

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

Returns:DividerConfiguration.DividerConfigurationBuilder

this builder

Exceptions

NullPointerException:: if color is null

parser back to summary

parser	back to summary
public DividerConfiguration.DividerConfigurationBuilder parser(MarkupParser parser) Sets the `MarkupParser` used to resolve markup tags in the divider title. Parameters parser:MarkupParser the parser to use; must not be `null` Returns:DividerConfiguration.DividerConfigurationBuilder this builder Exceptions NullPointerException: if `parser` is `null`

public DividerConfiguration.DividerConfigurationBuilder parser(MarkupParser parser)

Sets the MarkupParser used to resolve markup tags in the divider title.

Parameters

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

Returns:DividerConfiguration.DividerConfigurationBuilder

this builder

Exceptions

NullPointerException:: if parser is null