Package com.calebleavell.jatui.modules

Class TextInputModule.Builder

java.lang.Object

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

com.calebleavell.jatui.modules.TextInputModule.Builder

All Implemented Interfaces:

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

Enclosing class:

TextInputModule

public static class TextInputModule.Builder
extends TUIModule.Builder<TextInputModule.Builder>

Builder for TextInputModule.

Required fields: name, displayText
Optional fields: handlers

Implementation Note:

The names for the InputHandler objects monotonically increase based on an iterator handlerNum, so the name format follows "<this.name>-<this.handlerNum>".

Nested Class Summary

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

DirectedGraphNode.PropertyUpdateFlag

Field Summary

Fields

Modifier and Type	Field	Description
protected TextModule.Builder	displayText	The TextModule that displays text for getting input (e.g., "Your Input: ").
protected ContainerModule.Builder	handlers	The container for the InputHandler objects that will operate on the input collected by this module.

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	Builder()
protected	Builder(String name, String displayText)

Method Summary

Modifier and Type	Method	Description
TextInputModule.Builder	addHandler(FunctionModule.Builder handler)	Adds a function module to execute after input is collected.
TextInputModule.Builder	addHandler(String name, Function<String,?> logic)	Adds an InputHandler based on the provided logic.
TextInputModule.Builder	addSafeHandler(String name, Function<String,?> logic)	Adds an InputHandler based on the provided logic.
TextInputModule.Builder	addSafeHandler(String name, Function<String,?> logic, String exceptionMessage)	Adds an InputHandler based on the provided logic.
<T> TextInputModule.Builder	addSafeHandler(String name, Function<String,T> logic, Consumer<String> exceptionHandler)	Adds an InputHandler based on the provided logic.
TextInputModule	build()	Builds a new TextInputModule based on the configuration of this builder.
protected TextInputModule.Builder	createInstance()	Gets a fresh instance of this type of Builder.
protected TextInputModule.Builder	deepCopy(TextInputModule.Builder original, Map<TUIModule.Builder<?>,TUIModule.Builder<?>> visited)	In order to maintain the reference to the new children, access to the visited map is used, and thus TUIModule.Builder.deepCopy(TUIModule.Builder, Map) needs to be overridden.
TextModule.Builder	getDisplayText()	The TextModule that displays text for getting input (e.g., "Your Input: ").
TextInputModule.Builder	name(String name)	Sets the name of the module.
protected void	shallowCopy(TextInputModule.Builder original)	Copies handlerNum and delegates to TUIModule.Builder.shallowCopy(TUIModule.Builder).
boolean	shallowStructuralEquals(TextInputModule.Builder first, TextInputModule.Builder second)	Checks equality for properties given by the builder.

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, 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

Field Details

handlers

protected ContainerModule.Builder handlers

The container for the InputHandler objects that will operate on the input collected by this module.

displayText

protected TextModule.Builder displayText

The TextModule that displays text for getting input (e.g., "Your Input: ").

Constructor Details

Builder

protected Builder(String name,
 String displayText)

Builder

protected Builder()

Method Details

createInstance

protected TextInputModule.Builder 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<TextInputModule.Builder>

Returns:

A fresh, empty instance.

shallowCopy

protected void shallowCopy(TextInputModule.Builder original)

Copies handlerNum and delegates to TUIModule.Builder.shallowCopy(TUIModule.Builder).

Overrides:

shallowCopy in class TUIModule.Builder<TextInputModule.Builder>

Parameters:

original - The builder to copy from

deepCopy

protected TextInputModule.Builder deepCopy(TextInputModule.Builder original,
 Map<TUIModule.Builder<?>,TUIModule.Builder<?>> visited)

In order to maintain the reference to the new children, access to the visited map is used, and thus TUIModule.Builder.deepCopy(TUIModule.Builder, Map) needs to be overridden.

Overrides:

deepCopy in class TUIModule.Builder<TextInputModule.Builder>

Parameters:

original - The module to copy from.

visited - All children that have already been deep-copied.

Returns:

The instance that was copied into (self if original hasn't been visited yet).

shallowStructuralEquals

public boolean shallowStructuralEquals(TextInputModule.Builder first,
 TextInputModule.Builder second)

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

Specified by:

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

Overrides:

shallowStructuralEquals in class TUIModule.Builder<TextInputModule.Builder>

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

name

public TextInputModule.Builder name(String name)

Sets the name of the module. Also updates the input name to check for any declared InputHandler objects attached via addHandler(FunctionModule.Builder) or similar.

Overrides:

name in class TUIModule.Builder<TextInputModule.Builder>

Parameters:

name - The unique name of this module.

Returns:

self

getDisplayText

public TextModule.Builder getDisplayText()

The TextModule that displays text for getting input (e.g., "Your Input: ").

Returns:

The display text for this module.

addHandler

public TextInputModule.Builder addHandler(FunctionModule.Builder handler)

Adds a function module to execute after input is collected.
Note: this module will not update application or other properties for handler; this must be done manually. This is because handler gets wrapped in an InputHandler.

Parameters:

handler - The Function Module builder to execute after input is collected

Returns:

self

addHandler

public TextInputModule.Builder addHandler(String name,
 Function<String,?> logic)

Adds an InputHandler based on the provided logic.

Parameters:

name - The name of the function module that the InputHandler will wrap. This means whatever logic returns can be accessed via app.getInput(<name>) or equivalent.

logic - The Function to execute, that receives the input the built TextInputModule collects and outputs some object that is saved to the application with name as the identifier.

Returns:

self

addSafeHandler

public <T> TextInputModule.Builder addSafeHandler(String name,
 Function<String,T> logic,
 Consumer<String> exceptionHandler)

Adds an InputHandler based on the provided logic. If a RuntimeException is thrown during the execution of logic, it is caught and exceptionHandler can perform some recovery action. If you just want to print some error message and rerun the input, use addSafeHandler(String, Function, String) or addSafeHandler(String, Function) for a default message (TextInputModule.INVALID).

Parameters:

name - The name of the function module that the InputHandler will wrap. This means whatever this logic returns can be accessed via app.getInput(<name>) or equivalent.

logic - The Function to execute, that receives the input the built TextInputModule collects and outputs some object that is saved to the application with name as the identifier.

exceptionHandler - The recovery mechanism if logic throws a RuntimeException.

Returns:

self

addSafeHandler

public TextInputModule.Builder addSafeHandler(String name,
 Function<String,?> logic,
 String exceptionMessage)

Adds an InputHandler based on the provided logic. If a RuntimeException is thrown during the execution of logic, it is caught and the input is recollected. Use addSafeHandler(String, Function) for a default message (TextInputModule.INVALID).

Parameters:

name - The name of the function module that the InputHandler will wrap. This means whatever this logic returns can be accessed via app.getInput(<name>) or equivalent.

logic - The Function to execute, that receives the input the built TextInputModule collects and outputs some object that is saved to the application with name as the identifier.

exceptionMessage - The message to display if logic throws a RuntimeException, before the input gets recollected.

Returns:

self

addSafeHandler

public TextInputModule.Builder addSafeHandler(String name,
 Function<String,?> logic)

Adds an InputHandler based on the provided logic. If a RuntimeException is thrown during the execution of logic, it is caught and the input is recollected. The message provided by TextInputModule.INVALID is shown before rerunning. For a custom invalid message, use addSafeHandler(String, Function, String).

Parameters:

name - The name of the function module that the InputHandler will wrap. This means whatever this logic returns can be accessed via app.getInput(<name>) or equivalent.

logic - The Function to execute, that receives the input the built TextInputModule collects and outputs some object that is saved to the application with name as the identifier.

Returns:

self

build

public TextInputModule build()

Builds a new TextInputModule based on the configuration of this builder.

Specified by:

build in class TUIModule.Builder<TextInputModule.Builder>

Returns:

The new TextInputModule.

Implementation Note:

Removes and re-adds displayText and handlers to the children in order to allow displayText to a be a field of the built module, and for handlers to be at the end.