Package com.calebleavell.jatui.templates

Class NumberedList

java.lang.Object

com.calebleavell.jatui.modules.TUIModule.Builder<NumberedList>

com.calebleavell.jatui.modules.ModuleTemplate<NumberedList>

com.calebleavell.jatui.templates.NumberedList

All Implemented Interfaces:

DirectedGraphNode<TUIModule.Property,TUIModule.Builder<?>,NumberedList>

public class NumberedList
extends ModuleTemplate<NumberedList>

Handles displaying a list of text as a numbered list.

Example usage:

        NumberedList list = NumberedList.builder("list")
                 .setStart(4)
                 .setStep(2)
                 .addListText("item 1", "item 2", "item 3");

         list.build().run();
 

Outputs:

 [4] item 1
 [6] item 2
 [8] item 3
 

Nested Class Summary

Nested classes/interfaces inherited from interface com.calebleavell.jatui.core.DirectedGraphNode

DirectedGraphNode.PropertyUpdateFlag

Field Summary

Fields inherited from class com.calebleavell.jatui.modules.ModuleTemplate

main

Fields inherited from class com.calebleavell.jatui.modules.TUIModule.Builder

ansi, application, children, enableAnsi, logger, name, printStream, propertyUpdateFlags, scanner, type, usedNames

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	NumberedList()
protected	NumberedList(String name)

Method Summary

Modifier and Type	Method	Description
NumberedList	addListText(String listText)	Adds a single list item.
NumberedList	addListText(String... listText)	Adds zero or more list items.
static NumberedList	builder(String name)	Constructs a new NumberedList builder.
protected NumberedList	createInstance()	Gets a fresh instance of this type of Builder.
void	shallowCopy(NumberedList original)	Copies start, step, and i, and delegates to TUIModule.Builder.shallowCopy(TUIModule.Builder).
boolean	shallowStructuralEquals(NumberedList first, NumberedList second)	Checks equality for properties given by the builder.
NumberedList	start(int start)	start is the value of the identifier of the first list item (e.g., "[5] item").
NumberedList	step(int step)	step determines how much to increment the list number after every list item.

Methods inherited from class com.calebleavell.jatui.modules.ModuleTemplate

build, deepCopy

Methods inherited from class com.calebleavell.jatui.modules.TUIModule.Builder

addChild, addChild, addChildren, addChildren, appendStyle, application, clearChildren, deepCopy, enableAnsi, getAnsi, getAnsiEnabled, getApplication, getChild, getChild, getChildren, getCopy, getDeepCopy, getName, getPrintStream, getPropertyUpdateFlags, getScanner, getType, lockProperty, name, prependStyle, prependToName, printStream, scanner, self, structuralEquals, style, toString, unlockProperty, updateFlag, updateProperties

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.calebleavell.jatui.core.DirectedGraphNode

abstractSelf, containsNullNode, containsNullNode, dfs, dfs, forEach, forEachChild, structuralEquals, structuralEquals, updateProperty, updateProperty

Constructor Details

NumberedList

protected NumberedList(String name)

NumberedList

protected NumberedList()

Method Details

builder

public static NumberedList builder(String name)

Constructs a new NumberedList builder.

Parameters:

name - The name of the builder.

Returns:

The new builder.

createInstance

protected NumberedList createInstance()

Gets a fresh instance of this type of Builder. Note, this is intended only for copying utility and may have unknown consequences if used in other ways.

Specified by:

createInstance in class TUIModule.Builder<NumberedList>

Returns:

A fresh, empty instance.

shallowCopy

public void shallowCopy(NumberedList original)

Copies start, step, and i, and delegates to TUIModule.Builder.shallowCopy(TUIModule.Builder).

Overrides:

shallowCopy in class TUIModule.Builder<NumberedList>

Parameters:

original - The builder to copy from.

addListText

public NumberedList addListText(String listText)

Adds a single list item. Adheres to the start and step set by start(int) and step(int).

Parameters:

listText - The item to display (e.g., "[5] listText").

Returns:

self

addListText

public NumberedList addListText(String... listText)

Adds zero or more list items. Adheres to the start and step set by start(int) and step(int).
Example:

        NumberedList list = NumberedList.builder("list")
                 .addListText("item 1", "item 2", "item 3");

         list.build().run();
 

Outputs:

 [1] item 1
 [2] item 2
 [3] item 3
 

Parameters:

listText - The items to display.

Returns:

self

start

public NumberedList start(int start)

start is the value of the identifier of the first list item (e.g., "[5] item").

Parameters:

start - The starting number for the list.

Returns:

self

step

public NumberedList step(int step)

step determines how much to increment the list number after every list item.

Parameters:

step - The amount to increment every list number.

Returns:

self

shallowStructuralEquals

public boolean shallowStructuralEquals(NumberedList first,
 NumberedList second)

Checks equality for properties given by the builder. For NumberedList, this includes start, step, and i, as well as other requirements provided by TUIModule.Builder.shallowStructuralEquals(TUIModule.Builder, TUIModule.Builder).

Specified by:

shallowStructuralEquals in interface DirectedGraphNode<TUIModule.Property,TUIModule.Builder<?>,NumberedList>

Overrides:

shallowStructuralEquals in class TUIModule.Builder<NumberedList>

Parameters:

first - The first TUIModule to compare

second - The second TUIModule to compare

Returns:

true if first and second are equal according to builder-provided properties