Package com.calebleavell.jatui.templates

Class NumberedModuleSelector

java.lang.Object

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

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

com.calebleavell.jatui.templates.NumberedModuleSelector

All Implemented Interfaces:

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

public class NumberedModuleSelector
extends ModuleTemplate<NumberedModuleSelector>

Handles navigating to a module based on a user's decision.

Example usage:

 ApplicationModule app = ApplicationModule.builder("app").build();

 NumberedModuleSelector selector = NumberedModuleSelector.builder("selector", app)
  .addModule("Display Hello", TextModule.builder("display-hello", "Hello"))
  .addModule("Display World", TextModule.builder("display-world", "World"));

 app.setHome(selector);
 app.run();
 

Output:

 [1] Display Hello
 [2] Display World
 Your choice: 1
 Hello
 Exiting...
 

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	NumberedModuleSelector()
protected	NumberedModuleSelector(String name, ApplicationModule app)	Constructor for NumberedModuleSelector.

Method Summary

Modifier and Type	Method	Description
NumberedModuleSelector	addModule(TUIModule.Builder<?> module)	Adds a module option to the selector.
NumberedModuleSelector	addModule(String moduleName)	Adds a module option to the selector.
NumberedModuleSelector	addModule(String displayText, TUIModule.Builder<?> module)	Adds a module option to the selector.
NumberedModuleSelector	addModule(String displayText, String moduleName)	Adds a module option to the selector.
static NumberedModuleSelector	builder(String name, ApplicationModule app)	Constructs a new NumberedModuleSelector builder.
protected NumberedModuleSelector	createInstance()	Gets a fresh instance of this type of Builder.
void	shallowCopy(NumberedModuleSelector original)	Copies the NameOrModule objects and the NumberedList object, and delegates to TUIModule.Builder.shallowCopy(TUIModule.Builder).
boolean	shallowStructuralEquals(NumberedModuleSelector first, NumberedModuleSelector second)	Checks equality for properties given by the builder.

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

NumberedModuleSelector

protected NumberedModuleSelector(String name,
 ApplicationModule app)

Constructor for NumberedModuleSelector.

Parameters:

name - The name of the module.

app - The application to work with. Calls TUIModule.Builder.application(ApplicationModule).

NumberedModuleSelector

protected NumberedModuleSelector()

Method Details

builder

public static NumberedModuleSelector builder(String name,
 ApplicationModule app)

Constructs a new NumberedModuleSelector builder.

Parameters:

name - The name of the builder.

app - The ApplicationModule this module will be tied to.

Returns:

The new builder.

createInstance

protected NumberedModuleSelector 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<NumberedModuleSelector>

Returns:

A fresh, empty instance.

shallowCopy

public void shallowCopy(NumberedModuleSelector original)

Copies the NameOrModule objects and the NumberedList object, and delegates to TUIModule.Builder.shallowCopy(TUIModule.Builder).

Overrides:

shallowCopy in class TUIModule.Builder<NumberedModuleSelector>

Parameters:

original - The builder to copy from.

addModule

public NumberedModuleSelector addModule(String displayText,
 String moduleName)

Adds a module option to the selector. Adds displayText via NumberedList.addListText(String).

Parameters:

displayText - The text to display (e.g., if displayText="myText" "[1] myText).

moduleName - The name of the module the user may navigate to that is connected the ApplicationModule tied to this module (via either ApplicationModule.setHome(TUIModule.Builder) or TUIModule.Builder.addChild(TUIModule.Builder)). The module doesn't have to be a direct child.

Returns:

self

addModule

public NumberedModuleSelector addModule(String displayText,
 TUIModule.Builder<?> module)

Adds a module option to the selector. Adds displayText via NumberedList.addListText(String).

Parameters:

displayText - The text to display (e.g., if displayText="myText" "[1] myText).

module - The TUIModule.Builder the user may navigate to.

Returns:

self

addModule

public NumberedModuleSelector addModule(String moduleName)

Adds a module option to the selector. Uses the name of the module as the displayed list option. e.g., if the name of the module is "myModule", the option could be "[1] myModule."

Parameters:

moduleName - The name of the module the user may navigate to that is connected the ApplicationModule tied to this module (via either ApplicationModule.setHome(TUIModule.Builder) or TUIModule.Builder.addChild(TUIModule.Builder)). The module doesn't have to be a direct child.

Returns:

self

addModule

public NumberedModuleSelector addModule(TUIModule.Builder<?> module)

Adds a module option to the selector. Uses the name of the module as the displayed list option. e.g., if the name of the module is "myModule", the option could be "[1] myModule."

Parameters:

module - The TUIModule.Builder the user may navigate to.

Returns:

self

shallowStructuralEquals

public boolean shallowStructuralEquals(NumberedModuleSelector first,
 NumberedModuleSelector second)

Checks equality for properties given by the builder. For NumberedModuleSelector, this includes modules, as well as other requirements provided by TUIModule.Builder.shallowStructuralEquals(TUIModule.Builder, TUIModule.Builder).

Specified by:

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

Overrides:

shallowStructuralEquals in class TUIModule.Builder<NumberedModuleSelector>

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