Clique 4.0.3 · io.github.kusoroadeolu.clique.components.Divider

Modifier and Type	Field and Description
private final DividerConfiguration	configuration
private String	title
private final int	width

Access	Constructor and Description
public	Divider(int the width of the divider; must be greater than 0 width, DividerConfiguration the divider configuration to use; must not be `null` configuration) Creates a new Divider with the given width and configuration.

Modifier and Type	Method and Description
public boolean	equals(Object object) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public String	get() Implements io.github.kusoroadeolu.clique.components.Component.get. Builds and returns the fully formatted string representation of this component.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public Divider	Returns: this divider instance title(String the title to display; must not be `null` title) Sets the title to display centered within the divider line.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
private static void	validateWidth(int width)

Field Detail

configuration	back to summary
private final DividerConfiguration configuration

title	back to summary
private String title

width	back to summary
private final int width

Constructor Detail

Divider back to summary

Divider	back to summary
public Divider(int width, DividerConfiguration configuration) Creates a new Divider with the given width and configuration. Parameters width:int the width of the divider; must be greater than 0 configuration:DividerConfiguration the divider configuration to use; must not be `null` Exceptions IllegalArgumentException: if `width` is not greater than 0 NullPointerException: if `configuration` is `null`

public Divider(int width, DividerConfiguration configuration)

Creates a new Divider with the given width and configuration.

Parameters

width:int: the width of the divider; must be greater than 0
configuration:DividerConfiguration: the divider configuration to use; must not be null

Exceptions

IllegalArgumentException:: if width is not greater than 0
NullPointerException:: if configuration is null

Method Detail

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

get	back to summary
public String get() Implements io.github.kusoroadeolu.clique.components.Component.get. Doc from io.github.kusoroadeolu.clique.components.Component.get. Builds and returns the fully formatted string representation of this component. Each call performs a full render — no caching is implied by this interface. Implementations may document their own caching behavior if applicable. Annotations @Override

get

back to summary

public String get()

Implements io.github.kusoroadeolu.clique.components.Component.get.

Doc from io.github.kusoroadeolu.clique.components.Component.get.

Builds and returns the fully formatted string representation of this component.

Each call performs a full render — no caching is implied by this interface. Implementations may document their own caching behavior if applicable.

Annotations

@Override

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

title back to summary

title	back to summary
public Divider title(String title) Sets the title to display centered within the divider line. Parameters title:String the title to display; must not be `null` Returns:Divider this divider instance Exceptions NullPointerException: if `title` is `null` IllegalArgumentException: if the visible title length exceeds or is equal to the divider width

public Divider title(String title)

Sets the title to display centered within the divider line.

Parameters

title:String: the title to display; must not be null

Returns:Divider

this divider instance

Exceptions

NullPointerException:: if title is null
IllegalArgumentException:: if the visible title length exceeds or is equal to the divider width

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

validateWidth	back to summary
private static void validateWidth(int width)

public Class Divider

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail