Top Description Fields Constructors Methods
io.github.kusoroadeolu.clique.components

public Class ItemList

extends Object
implements Component
Class Inheritance
All Implemented Interfaces
io.github.kusoroadeolu.clique.components.Component
Annotations
@Stable
since:4.0.1
Imports
io.github.kusoroadeolu.clique.configuration.ItemListConfiguration, io.github.kusoroadeolu.clique.internal.ListItem, io.github.kusoroadeolu.clique.internal.documentation.Stable, io.github.kusoroadeolu.clique.internal.utils.StringUtils, java.util.ArrayList, .List, .Objects
A component representing a hierarchical list of items with customizable symbols and indentation.

Lists support nesting to create multi-level structures. Each level of nesting increases the indentation based on the ItemListConfiguration.

Resolution Order:

  1. The parent list is traversed sequentially.
  2. For each item, the symbol and content are appended.
  3. If a sublist exists, it is recursively resolved with an incremented depth before the next item in the parent list is processed.

Scoping: Sublists added via item(String, String, ItemList) are automatically reconfigured to inherit the configuration of the parent list. Self-nesting is strictly prohibited.

Thread Safety: This class is not thread-safe. The internal item storage is mutable, and the configuration may be updated internally during nesting operations.

Since
4.0.0

Field Summary

Modifier and TypeField and Description
private ItemListConfiguration
configuration

private final List<ListItem>
items

private String
lastSymbol

private static final ItemList
NONE

Constructor Summary

AccessConstructor and Description
public
ItemList(ItemListConfiguration configuration)

public
ItemList()

Method Summary

Modifier and TypeMethod and Description
pack-priv void
assertNotSelf(ItemList list)

pack-priv void
buildList(StringBuilder sb, int depth, ItemList root)

pack-priv ItemList
child()

Internal test helper to retrieve the first child sublist.

pack-priv ItemListConfiguration
configuration()

Internal test helper to retrieve the current configuration.

public boolean
equals(Object o)

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 ItemList

Returns:

this list instance for method chaining
item(String
the character or string to use as the item marker (e.g., "*", "-")
symbol, String
the text content of the item
content, ItemList
the nested sublist; must not be null
subList)

Adds an item to the list with an associated sublist.

public ItemList

Returns:

this list instance for method chaining
item(String
the character or string to use as the item marker
symbol, String
the text content of the item
content)

Adds a leaf item to the list with no sublist.

public ItemList

Returns:

this list instance for method chaining
item(String
the text content of the item
content)

Adds a leaf item to the list with no sublist.

private String
parseString(String str)

pack-priv ItemList
recursivelySetConfiguration(ItemListConfiguration configuration)

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

configurationback to summary
private ItemListConfiguration configuration
itemsback to summary
private final List<ListItem> items
lastSymbolback to summary
private String lastSymbol
NONEback to summary
private static final ItemList NONE

Constructor Detail

ItemListback to summary
public ItemList(ItemListConfiguration configuration)
ItemListback to summary
public ItemList()

Method Detail

assertNotSelfback to summary
pack-priv void assertNotSelf(ItemList list)
buildListback to summary
pack-priv void buildList(StringBuilder sb, int depth, ItemList root)
childback to summary
pack-priv ItemList child()

Internal test helper to retrieve the first child sublist.

configurationback to summary
pack-priv ItemListConfiguration configuration()

Internal test helper to retrieve the current configuration.

equalsback 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
getback 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.

Returns the fully formatted hierarchical list as a string, with markup resolved according to the current configuration.

Annotations
@Override
hashCodeback 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
itemback to summary
public ItemList item(String symbol, String content, ItemList subList)

Adds an item to the list with an associated sublist.

The sublist will be modified to use the parent's configuration.

Parameters
symbol:String

the character or string to use as the item marker (e.g., "*", "-")

content:String

the text content of the item

subList:ItemList

the nested sublist; must not be null

Returns:ItemList

this list instance for method chaining

Exceptions
IllegalArgumentException:
if subList is this instance
NullPointerException:
if subList is null
itemback to summary
public ItemList item(String symbol, String content)

Adds a leaf item to the list with no sublist.

Parameters
symbol:String

the character or string to use as the item marker

content:String

the text content of the item

Returns:ItemList

this list instance for method chaining

itemback to summary
public ItemList item(String content)

Adds a leaf item to the list with no sublist. Uses the last used symbol for this item

Parameters
content:String

the text content of the item

Returns:ItemList

this list instance for method chaining

parseStringback to summary
private String parseString(String str)
recursivelySetConfigurationback to summary
pack-priv ItemList recursivelySetConfiguration(ItemListConfiguration configuration)
toStringback 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