Modifier and Type	Class and Description
public static class	FrameConfiguration.FrameConfigurationBuilder Builder for `FrameConfiguration`.

Modifier and Type	Field and Description
private final FrameAlign	align
private final AnsiCode[]	borderColor
public static final FrameConfiguration	DEFAULT A default `FrameConfiguration` with padding `2`, center alignment, the default markup parser, and no border color.
private final int	padding
private final MarkupParser	parser

Access	Constructor and Description
private	FrameConfiguration()
private	FrameConfiguration(FrameConfiguration.FrameConfigurationBuilder builder)

Method Summary

Modifier and Type	Method and Description
public static FrameConfiguration.FrameConfigurationBuilder	Returns: a new `FrameConfigurationBuilder` builder() Returns a new builder for constructing a `FrameConfiguration`.
public boolean	equals(Object object) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public AnsiCode[]	Returns: the border color codes; never `null`, may be empty getBorderColor() Returns the ANSI codes applied to the frame border, or an empty array if no border color has been set.
public FrameAlign	Returns: the frame alignment; never `null` getFrameAlign() Returns the default horizontal alignment applied to nested content.
public int	Returns: the padding value; always `>= 0` getPadding() Returns the number of blank characters inserted between the frame border and its content on each side.
public MarkupParser	Returns: the parser; never `null` getParser() Returns the markup parser used to interpret inline style tags in nested strings and border color specifications.
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

align	back to summary
private final FrameAlign align

borderColor	back to summary
private final AnsiCode[] borderColor

DEFAULT	back to summary
public static final FrameConfiguration DEFAULT A default `FrameConfiguration` with padding `2`, center alignment, the default markup parser, and no border color.

padding	back to summary
private final int padding

parser	back to summary
private final MarkupParser parser

Constructor Detail

FrameConfiguration	back to summary
private FrameConfiguration()

FrameConfiguration	back to summary
private FrameConfiguration(FrameConfiguration.FrameConfigurationBuilder builder)

Method Detail

builder back to summary

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

public static FrameConfiguration.FrameConfigurationBuilder builder()

Returns a new builder for constructing a FrameConfiguration.

Returns:FrameConfiguration.FrameConfigurationBuilder: a new FrameConfigurationBuilder

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

getBorderColor back to summary

getBorderColor	back to summary
public AnsiCode[] getBorderColor() Returns the ANSI codes applied to the frame border, or an empty array if no border color has been set. Returns:AnsiCode[] the border color codes; never `null`, may be empty

public AnsiCode[] getBorderColor()

Returns the ANSI codes applied to the frame border, or an empty array if no border color has been set.

Returns:AnsiCode[]: the border color codes; never null, may be empty

getFrameAlign back to summary

getFrameAlign	back to summary
public FrameAlign getFrameAlign() Returns the default horizontal alignment applied to nested content. Individual nodes may override this value at nest time via `io.github.kusoroadeolu.clique.components.Frame#nest(String, io.github.kusoroadeolu.clique.configuration.FrameAlign)`. Returns:FrameAlign the frame alignment; never `null`

public FrameAlign getFrameAlign()

Returns the default horizontal alignment applied to nested content.

Individual nodes may override this value at nest time via io.github.kusoroadeolu.clique.components.Frame#nest(String, io.github.kusoroadeolu.clique.configuration.FrameAlign).

Returns:FrameAlign: the frame alignment; never null

getPadding back to summary

getPadding	back to summary
public int getPadding() Returns the number of blank characters inserted between the frame border and its content on each side. Returns:int the padding value; always `>= 0`

public int getPadding()

Returns the number of blank characters inserted between the frame border and its content on each side.

Returns:int: the padding value; always >= 0

getParser back to summary

getParser	back to summary
public MarkupParser getParser() Returns the markup parser used to interpret inline style tags in nested strings and border color specifications. Returns:MarkupParser the parser; never `null`

public MarkupParser getParser()

Returns the markup parser used to interpret inline style tags in nested strings and border color specifications.

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 FrameConfiguration.FrameConfigurationBuilder

Class Inheritance

extends Object

java.lang.Object
io.github.kusoroadeolu.clique.configuration.FrameConfiguration.FrameConfigurationBuilder

Builder for FrameConfiguration.

Default values match those of FrameConfiguration#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[]	borderColor
private FrameAlign	frameAlign
private int	padding
private MarkupParser	parser

Constructor Summary

Access	Constructor and Description
public	FrameConfigurationBuilder()

Method Summary

Modifier and Type	Method and Description
public FrameConfiguration.FrameConfigurationBuilder	Returns: this builder borderColor(String a markup string representing the desired border color; must not be `null` borderColor) Sets the border color by parsing a markup string using the currently configured parser.
public FrameConfiguration.FrameConfigurationBuilder	Returns: this builder borderColor(AnsiCode... the ANSI codes to apply to the border; must not be `null` borderColor) Sets the border color directly from one or more `AnsiCode` instances.
public FrameConfiguration	Returns: a new, immutable `FrameConfiguration` build() Constructs a new `FrameConfiguration` from the current builder state.
public FrameConfiguration.FrameConfigurationBuilder	Returns: this builder frameAlign(FrameAlign the alignment to apply; must not be `null` align) Sets the default horizontal alignment for content nested in the frame.
public FrameConfiguration.FrameConfigurationBuilder	Returns: this builder padding(int the number of blank characters on each side; must be `>= 0` padding) Sets the padding applied between the frame border and its content.
public FrameConfiguration.FrameConfigurationBuilder	Returns: this builder parser(MarkupParser the parser to use; must not be `null` parser) Sets the markup parser used to interpret inline style tags in nested content and border color markup strings.

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

Field Detail

borderColor	back to summary
private AnsiCode[] borderColor

frameAlign	back to summary
private FrameAlign frameAlign

padding	back to summary
private int padding

parser	back to summary
private MarkupParser parser

Constructor Detail

FrameConfigurationBuilder	back to summary
public FrameConfigurationBuilder()

Method Detail

borderColor back to summary

borderColor	back to summary
public FrameConfiguration.FrameConfigurationBuilder borderColor(String borderColor) Sets the border 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. Parameters borderColor:String a markup string representing the desired border color; must not be `null` Returns:FrameConfiguration.FrameConfigurationBuilder this builder

public FrameConfiguration.FrameConfigurationBuilder borderColor(String borderColor)

Sets the border 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.

Parameters

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

Returns:FrameConfiguration.FrameConfigurationBuilder

this builder

borderColor back to summary

borderColor	back to summary
public FrameConfiguration.FrameConfigurationBuilder borderColor(AnsiCode... borderColor) Sets the border color directly from one or more `AnsiCode` instances. Parameters borderColor:AnsiCode[] the ANSI codes to apply to the border; must not be `null` Returns:FrameConfiguration.FrameConfigurationBuilder this builder Exceptions NullPointerException: if `borderColor` is `null`

public FrameConfiguration.FrameConfigurationBuilder borderColor(AnsiCode... borderColor)

Sets the border color directly from one or more AnsiCode instances.

Parameters

borderColor:AnsiCode[]: the ANSI codes to apply to the border; must not be null

Returns:FrameConfiguration.FrameConfigurationBuilder

this builder

Exceptions

NullPointerException:: if borderColor is null

build back to summary

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

public FrameConfiguration build()

Constructs a new FrameConfiguration from the current builder state.

Returns:FrameConfiguration: a new, immutable FrameConfiguration

frameAlign back to summary

frameAlign	back to summary
public FrameConfiguration.FrameConfigurationBuilder frameAlign(FrameAlign align) Sets the default horizontal alignment for content nested in the frame. This value is used when content is added without an explicit alignment. Individual nodes may override it at nest time. Parameters align:FrameAlign the alignment to apply; must not be `null` Returns:FrameConfiguration.FrameConfigurationBuilder this builder Exceptions NullPointerException: if `align` is `null`

public FrameConfiguration.FrameConfigurationBuilder frameAlign(FrameAlign align)

Sets the default horizontal alignment for content nested in the frame.

This value is used when content is added without an explicit alignment. Individual nodes may override it at nest time.

Parameters

align:FrameAlign: the alignment to apply; must not be null

Returns:FrameConfiguration.FrameConfigurationBuilder

this builder

Exceptions

NullPointerException:: if align is null

padding back to summary

padding	back to summary
public FrameConfiguration.FrameConfigurationBuilder padding(int padding) Sets the padding applied between the frame border and its content. Parameters padding:int the number of blank characters on each side; must be `>= 0` Returns:FrameConfiguration.FrameConfigurationBuilder this builder Exceptions IllegalArgumentException: if `padding` is negative

public FrameConfiguration.FrameConfigurationBuilder padding(int padding)

Sets the padding applied between the frame border and its content.

Parameters

padding:int: the number of blank characters on each side; must be >= 0

Returns:FrameConfiguration.FrameConfigurationBuilder

this builder

Exceptions

IllegalArgumentException:: if padding is negative

parser back to summary

parser	back to summary
public FrameConfiguration.FrameConfigurationBuilder parser(MarkupParser parser) Sets the markup parser used to interpret inline style tags in nested content and border color markup strings. Parameters parser:MarkupParser the parser to use; must not be `null` Returns:FrameConfiguration.FrameConfigurationBuilder this builder Exceptions NullPointerException: if `parser` is `null`

public FrameConfiguration.FrameConfigurationBuilder parser(MarkupParser parser)

Sets the markup parser used to interpret inline style tags in nested content and border color markup strings.

Parameters

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

Returns:FrameConfiguration.FrameConfigurationBuilder

this builder

Exceptions

NullPointerException:: if parser is null

public final Class FrameConfiguration

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class FrameConfiguration.FrameConfigurationBuilder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail