Modifier and Type	Class and Description
public static class	TableConfiguration.TableConfigurationBuilder Builder for `TableConfiguration` instances.

Modifier and Type	Field and Description
private final CellAlign	alignment
private final AnsiCode[]	borderColor
private final Map<Integer, CellAlign>	columnAlignment
public static final TableConfiguration	DEFAULT The default table configuration.
private final String	nullReplacement
private final int	padding
private final MarkupParser	parser

Access	Constructor and Description
private	TableConfiguration()
private	TableConfiguration(TableConfiguration.TableConfigurationBuilder builder)

Method Summary

Modifier and Type	Method and Description
public static TableConfiguration.TableConfigurationBuilder	Returns: a new builder instance builder() Creates a new builder for constructing a `TableConfiguration`.
public boolean	equals(Object object) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public CellAlign	Returns: the default cell alignment getAlignment() Returns the global alignment setting for table cells.
public AnsiCode[]	Returns: a copy of the border color ANSI codes getBorderColor() Returns the ANSI codes used to style the table borders.
public Map<Integer, CellAlign>	Returns: a copy of the column alignment map getColumnAlignment() Returns the map of column-specific alignments.
public String	Returns: the null replacement string getNullReplacement() Returns the string used to replace null cell values.
public int	Returns: the number of spaces used for padding getPadding() Returns the horizontal padding applied to cell content.
public MarkupParser	Returns: the markup parser getParser() Returns the parser used for resolving markup within cell content.
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

alignment	back to summary
private final CellAlign alignment

borderColor	back to summary
private final AnsiCode[] borderColor

columnAlignment	back to summary
private final Map<Integer, CellAlign> columnAlignment

DEFAULT	back to summary
public static final TableConfiguration DEFAULT The default table configuration.

nullReplacement	back to summary
private final String nullReplacement

padding	back to summary
private final int padding

parser	back to summary
private final MarkupParser parser

TableConfiguration	back to summary
private TableConfiguration()

TableConfiguration	back to summary
private TableConfiguration(TableConfiguration.TableConfigurationBuilder builder)

Method Detail

builder back to summary

builder	back to summary
public static TableConfiguration.TableConfigurationBuilder builder() Creates a new builder for constructing a `TableConfiguration`. Returns:TableConfiguration.TableConfigurationBuilder a new builder instance

public static TableConfiguration.TableConfigurationBuilder builder()

Creates a new builder for constructing a TableConfiguration.

Returns:TableConfiguration.TableConfigurationBuilder: a new builder instance

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

getAlignment	back to summary
public CellAlign getAlignment() Returns the global alignment setting for table cells. Returns:CellAlign the default cell alignment

getAlignment

back to summary

public CellAlign getAlignment()

Returns the global alignment setting for table cells.

Returns:CellAlign: the default cell alignment

getBorderColor	back to summary
public AnsiCode[] getBorderColor() Returns the ANSI codes used to style the table borders. Returns:AnsiCode[] a copy of the border color ANSI codes

getBorderColor

back to summary

public AnsiCode[] getBorderColor()

Returns the ANSI codes used to style the table borders.

Returns:AnsiCode[]: a copy of the border color ANSI codes

getColumnAlignment	back to summary
public Map<Integer, CellAlign> getColumnAlignment() Returns the map of column-specific alignments. Returns:Map<Integer, CellAlign> a copy of the column alignment map

getColumnAlignment

back to summary

public Map<Integer, CellAlign> getColumnAlignment()

Returns the map of column-specific alignments.

Returns:Map<Integer, CellAlign>: a copy of the column alignment map

getNullReplacement	back to summary
public String getNullReplacement() Returns the string used to replace null cell values. Returns:String the null replacement string

getNullReplacement

back to summary

public String getNullReplacement()

Returns the string used to replace null cell values.

Returns:String: the null replacement string

getPadding	back to summary
public int getPadding() Returns the horizontal padding applied to cell content. Returns:int the number of spaces used for padding

getPadding

back to summary

public int getPadding()

Returns the horizontal padding applied to cell content.

Returns:int: the number of spaces used for padding

getParser	back to summary
public MarkupParser getParser() Returns the parser used for resolving markup within cell content. Returns:MarkupParser the markup parser

getParser

back to summary

public MarkupParser getParser()

Returns the parser used for resolving markup within cell content.

Returns:MarkupParser: the markup parser

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 TableConfiguration.TableConfigurationBuilder

Class Inheritance

extends Object

java.lang.Object
io.github.kusoroadeolu.clique.configuration.TableConfiguration.TableConfigurationBuilder

Builder for TableConfiguration instances.

This builder is not thread-safe.

Field Summary

Modifier and Type	Field and Description
private CellAlign	alignment
private AnsiCode[]	borderColor
private Map<Integer, CellAlign>	columnAlignment
private String	nullReplacement
private int	padding
private MarkupParser	parser

Constructor Summary

Access	Constructor and Description
public	TableConfigurationBuilder()

Method Summary

Modifier and Type	Method and Description
public TableConfiguration.TableConfigurationBuilder	Returns: this builder alignment(CellAlign the cell alignment; must not be `null` alignment) Sets the default alignment for all table cells.
public TableConfiguration.TableConfigurationBuilder	Returns: this builder borderColor(String a string containing color tags e.g "red, bold". Note that the markup brackets should not be included borderColor) Sets the border color using a markup-styled string.
public TableConfiguration.TableConfigurationBuilder	Returns: this builder borderColor(AnsiCode... the ANSI codes to apply borderColor) Sets the border color using ANSI codes.
public TableConfiguration	Returns: a new configuration instance build() Builds a new `TableConfiguration` based on current settings.
public TableConfiguration.TableConfigurationBuilder	Returns: this builder columnAlignment(Map<Integer, CellAlign> the mapping of column indices; must not be `null` columnAlignment) Sets column-specific alignments using a map of column indices to alignments.
public TableConfiguration.TableConfigurationBuilder	Returns: this builder columnAlignment(int the 0-based index of the column column, CellAlign the alignment to apply; must not be `null` alignment) Sets the alignment for a specific column.
public TableConfiguration.TableConfigurationBuilder	Returns: this builder nullReplacement(String the replacement string; must not be `null` nullReplacement) Sets the replacement string for cells containing `null`.
public TableConfiguration.TableConfigurationBuilder	Returns: this builder padding(int the number of spaces to apply; must not be negative padding) Sets the padding for table cells.
public TableConfiguration.TableConfigurationBuilder	Returns: this builder parser(MarkupParser the parser to use; must not be `null` parser) Sets the parser for markup resolution.

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

Field Detail

alignment	back to summary
private CellAlign alignment

borderColor	back to summary
private AnsiCode[] borderColor

columnAlignment	back to summary
private Map<Integer, CellAlign> columnAlignment

nullReplacement	back to summary
private String nullReplacement

padding	back to summary
private int padding

parser	back to summary
private MarkupParser parser

Constructor Detail

TableConfigurationBuilder	back to summary
public TableConfigurationBuilder()

Method Detail

alignment back to summary

alignment	back to summary
public TableConfiguration.TableConfigurationBuilder alignment(CellAlign alignment) Sets the default alignment for all table cells. Parameters alignment:CellAlign the cell alignment; must not be `null` Returns:TableConfiguration.TableConfigurationBuilder this builder Exceptions NullPointerException: if `alignment` is `null`

public TableConfiguration.TableConfigurationBuilder alignment(CellAlign alignment)

Sets the default alignment for all table cells.

Parameters

alignment:CellAlign: the cell alignment; must not be null

Returns:TableConfiguration.TableConfigurationBuilder

this builder

Exceptions

NullPointerException:: if alignment is null

borderColor back to summary

borderColor	back to summary
public TableConfiguration.TableConfigurationBuilder borderColor(String borderColor) Sets the border color using a markup-styled string. Parameters borderColor:String a string containing color tags e.g "red, bold". Note that the markup brackets should not be included Returns:TableConfiguration.TableConfigurationBuilder this builder Exceptions NullPointerException: if `borderColor` is `null`

public TableConfiguration.TableConfigurationBuilder borderColor(String borderColor)

Sets the border color using a markup-styled string.

Parameters

borderColor:String: a string containing color tags e.g "red, bold". Note that the markup brackets should not be included

Returns:TableConfiguration.TableConfigurationBuilder

this builder

Exceptions

NullPointerException:: if borderColor is null

borderColor back to summary

borderColor	back to summary
public TableConfiguration.TableConfigurationBuilder borderColor(AnsiCode... borderColor) Sets the border color using ANSI codes. Parameters borderColor:AnsiCode[] the ANSI codes to apply Returns:TableConfiguration.TableConfigurationBuilder this builder Exceptions NullPointerException: if `borderColor` is `null`

public TableConfiguration.TableConfigurationBuilder borderColor(AnsiCode... borderColor)

Sets the border color using ANSI codes.

Parameters

borderColor:AnsiCode[]: the ANSI codes to apply

Returns:TableConfiguration.TableConfigurationBuilder

this builder

Exceptions

NullPointerException:: if borderColor is null

build back to summary

build	back to summary
public TableConfiguration build() Builds a new `TableConfiguration` based on current settings. Returns:TableConfiguration a new configuration instance

public TableConfiguration build()

Builds a new TableConfiguration based on current settings.

Returns:TableConfiguration: a new configuration instance

columnAlignment back to summary

columnAlignment	back to summary
public TableConfiguration.TableConfigurationBuilder columnAlignment(Map<Integer, CellAlign> columnAlignment) Sets column-specific alignments using a map of column indices to alignments. Parameters columnAlignment:Map<Integer, CellAlign> the mapping of column indices; must not be `null` Returns:TableConfiguration.TableConfigurationBuilder this builder Exceptions NullPointerException: if `columnAlignment` is `null`

public TableConfiguration.TableConfigurationBuilder columnAlignment(Map<Integer, CellAlign> columnAlignment)

Sets column-specific alignments using a map of column indices to alignments.

Parameters

columnAlignment:Map<Integer, CellAlign>: the mapping of column indices; must not be null

Returns:TableConfiguration.TableConfigurationBuilder

this builder

Exceptions

NullPointerException:: if columnAlignment is null

columnAlignment back to summary

columnAlignment	back to summary
public TableConfiguration.TableConfigurationBuilder columnAlignment(int column, CellAlign alignment) Sets the alignment for a specific column. Scoping: This setting overrides the global table alignment for the specified column index. Parameters column:int the 0-based index of the column alignment:CellAlign the alignment to apply; must not be `null` Returns:TableConfiguration.TableConfigurationBuilder this builder Exceptions IllegalArgumentException: if `column < 0` NullPointerException: if `alignment` is `null`

public TableConfiguration.TableConfigurationBuilder columnAlignment(int column, CellAlign alignment)

Sets the alignment for a specific column.

Scoping: This setting overrides the global table alignment for the specified column index.

Parameters

column:int: the 0-based index of the column
alignment:CellAlign: the alignment to apply; must not be null

Returns:TableConfiguration.TableConfigurationBuilder

this builder

Exceptions

IllegalArgumentException:: if column < 0
NullPointerException:: if alignment is null

nullReplacement back to summary

nullReplacement	back to summary
public TableConfiguration.TableConfigurationBuilder nullReplacement(String nullReplacement) Sets the replacement string for cells containing `null`. Parameters nullReplacement:String the replacement string; must not be `null` Returns:TableConfiguration.TableConfigurationBuilder this builder Exceptions NullPointerException: if `nullReplacement` is `null`

public TableConfiguration.TableConfigurationBuilder nullReplacement(String nullReplacement)

Sets the replacement string for cells containing null.

Parameters

nullReplacement:String: the replacement string; must not be null

Returns:TableConfiguration.TableConfigurationBuilder

this builder

Exceptions

NullPointerException:: if nullReplacement is null

padding back to summary

padding	back to summary
public TableConfiguration.TableConfigurationBuilder padding(int padding) Sets the padding for table cells. Parameters padding:int the number of spaces to apply; must not be negative Returns:TableConfiguration.TableConfigurationBuilder this builder Exceptions IllegalArgumentException: if `padding < 0`

public TableConfiguration.TableConfigurationBuilder padding(int padding)

Sets the padding for table cells.

Parameters

padding:int: the number of spaces to apply; must not be negative

Returns:TableConfiguration.TableConfigurationBuilder

this builder

Exceptions

IllegalArgumentException:: if padding < 0

parser back to summary

parser	back to summary
public TableConfiguration.TableConfigurationBuilder parser(MarkupParser parser) Sets the parser for markup resolution. content will be treated as literal text and will not be parsed into ANSI sequences. Parameters parser:MarkupParser the parser to use; must not be `null` Returns:TableConfiguration.TableConfigurationBuilder this builder Exceptions NullPointerException: if `parser` is `null`

public TableConfiguration.TableConfigurationBuilder parser(MarkupParser parser)

Sets the parser for markup resolution. content will be treated as literal text and will not be parsed into ANSI sequences.

Parameters

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

Returns:TableConfiguration.TableConfigurationBuilder

this builder

Exceptions

NullPointerException:: if parser is null

public final Class TableConfiguration

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class TableConfiguration.TableConfigurationBuilder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail