Modifier and Type	Class and Description
public static class	ItemListConfiguration.ItemListConfigurationBuilder Builder for `ItemListConfiguration` instances.

Modifier and Type	Field and Description
public static final ItemListConfiguration	DEFAULT The default item list configuration.
private final int	indentSize
private final MarkupParser	parser
private final int	symbolSpacing

Access	Constructor and Description
private	ItemListConfiguration()
private	ItemListConfiguration(ItemListConfiguration.ItemListConfigurationBuilder builder)

Method Summary

Modifier and Type	Method and Description
public static ItemListConfiguration.ItemListConfigurationBuilder	Returns: a new builder instance builder() Creates a new builder for constructing an `ItemListConfiguration`.
public boolean	equals(Object o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public int	Returns: the indentation size getIndentSize() Returns the number of spaces used for each level of nesting.
public MarkupParser	Returns: the markup parser getParser() Returns the markup parser used to resolve tags in list content.
public int	Returns: the symbol spacing getSymbolSpacing() Returns the number of spaces between the item symbol and the item 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

DEFAULT	back to summary
public static final ItemListConfiguration DEFAULT The default item list configuration.

indentSize	back to summary
private final int indentSize

parser	back to summary
private final MarkupParser parser

symbolSpacing	back to summary
private final int symbolSpacing

Constructor Detail

ItemListConfiguration	back to summary
private ItemListConfiguration()

ItemListConfiguration	back to summary
private ItemListConfiguration(ItemListConfiguration.ItemListConfigurationBuilder builder)

Method Detail

builder back to summary

builder	back to summary
public static ItemListConfiguration.ItemListConfigurationBuilder builder() Creates a new builder for constructing an `ItemListConfiguration`. Returns:ItemListConfiguration.ItemListConfigurationBuilder a new builder instance

public static ItemListConfiguration.ItemListConfigurationBuilder builder()

Creates a new builder for constructing an ItemListConfiguration.

Returns:ItemListConfiguration.ItemListConfigurationBuilder: a new builder instance

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

getIndentSize	back to summary
public int getIndentSize() Returns the number of spaces used for each level of nesting. Returns:int the indentation size

getIndentSize

back to summary

public int getIndentSize()

Returns the number of spaces used for each level of nesting.

Returns:int: the indentation size

getParser	back to summary
public MarkupParser getParser() Returns the markup parser used to resolve tags in list content. Returns:MarkupParser the markup parser

getParser

back to summary

public MarkupParser getParser()

Returns the markup parser used to resolve tags in list content.

Returns:MarkupParser: the markup parser

getSymbolSpacing	back to summary
public int getSymbolSpacing() Returns the number of spaces between the item symbol and the item content. Returns:int the symbol spacing

getSymbolSpacing

back to summary

public int getSymbolSpacing()

Returns the number of spaces between the item symbol and the item content.

Returns:int: the symbol spacing

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 ItemListConfiguration.ItemListConfigurationBuilder

Class Inheritance

extends Object

java.lang.Object
io.github.kusoroadeolu.clique.configuration.ItemListConfiguration.ItemListConfigurationBuilder

Builder for ItemListConfiguration instances.

This builder is not thread-safe.

Field Summary

Modifier and Type	Field and Description
private int	indentSize
private MarkupParser	parser
private int	symbolSpacing

Constructor Summary

Access	Constructor and Description
public	ItemListConfigurationBuilder()

Method Summary

Modifier and Type	Method and Description
public ItemListConfiguration	Returns: a new configuration instance build() Builds a new `ItemListConfiguration` based on current settings.
public ItemListConfiguration.ItemListConfigurationBuilder	Returns: this builder indentSize(int the indentation size; must be at least 1 indentSize) Sets the number of spaces for each nesting level.
public ItemListConfiguration.ItemListConfigurationBuilder	Returns: this builder parser(MarkupParser the parser to use; must not be `null` parser) Sets the parser for markup resolution.
public ItemListConfiguration.ItemListConfigurationBuilder	Returns: this builder symbolSpacing(int the number of spaces; must not be negative spacing) Sets the spacing between the item symbol and content.

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

Field Detail

indentSize	back to summary
private int indentSize

parser	back to summary
private MarkupParser parser

symbolSpacing	back to summary
private int symbolSpacing

Constructor Detail

ItemListConfigurationBuilder	back to summary
public ItemListConfigurationBuilder()

Method Detail

build back to summary

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

public ItemListConfiguration build()

Builds a new ItemListConfiguration based on current settings.

Returns:ItemListConfiguration: a new configuration instance

indentSize back to summary

indentSize	back to summary
public ItemListConfiguration.ItemListConfigurationBuilder indentSize(int indentSize) Sets the number of spaces for each nesting level. Parameters indentSize:int the indentation size; must be at least 1 Returns:ItemListConfiguration.ItemListConfigurationBuilder this builder Exceptions IllegalArgumentException: if `indentSize < 1`

public ItemListConfiguration.ItemListConfigurationBuilder indentSize(int indentSize)

Sets the number of spaces for each nesting level.

Parameters

indentSize:int: the indentation size; must be at least 1

Returns:ItemListConfiguration.ItemListConfigurationBuilder

this builder

Exceptions

IllegalArgumentException:: if indentSize < 1

parser back to summary

parser	back to summary
public ItemListConfiguration.ItemListConfigurationBuilder parser(MarkupParser parser) Sets the parser for markup resolution. Parameters parser:MarkupParser the parser to use; must not be `null` Returns:ItemListConfiguration.ItemListConfigurationBuilder this builder Exceptions NullPointerException: if `parser` is `null`

public ItemListConfiguration.ItemListConfigurationBuilder parser(MarkupParser parser)

Sets the parser for markup resolution.

Parameters

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

Returns:ItemListConfiguration.ItemListConfigurationBuilder

this builder

Exceptions

NullPointerException:: if parser is null

symbolSpacing back to summary

symbolSpacing	back to summary
public ItemListConfiguration.ItemListConfigurationBuilder symbolSpacing(int spacing) Sets the spacing between the item symbol and content. Parameters spacing:int the number of spaces; must not be negative Returns:ItemListConfiguration.ItemListConfigurationBuilder this builder Exceptions IllegalArgumentException: if `spacing < 0`

public ItemListConfiguration.ItemListConfigurationBuilder symbolSpacing(int spacing)

Sets the spacing between the item symbol and content.

Parameters

spacing:int: the number of spaces; must not be negative

Returns:ItemListConfiguration.ItemListConfigurationBuilder

this builder

Exceptions

IllegalArgumentException:: if spacing < 0

public Class ItemListConfiguration

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class ItemListConfiguration.ItemListConfigurationBuilder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail