Package com.calebleavell.jatui.modules

Class TextInputModule

java.lang.Object

com.calebleavell.jatui.modules.TUIModule

com.calebleavell.jatui.modules.TextInputModule

public class TextInputModule
extends TUIModule

Handles collection of text for the application. Generally this means collecting user input from the console, but TUIModule.Builder.scanner(Scanner) can be used to collect input from other places as well.
A TextInputModule can't do much unless it belongs to an ApplicationModule. If it is tied to one, whatever input is collected is updated in the app's inputMap and can be accessed via ApplicationModule.getInput(String).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TextInputModule.Builder	Builder for TextInputModule.

Nested classes/interfaces inherited from class com.calebleavell.jatui.modules.TUIModule

TUIModule.Property

Field Summary

Fields

Modifier and Type	Field	Description
static final String	INVALID	A basic default error message if input is determined to be invalid via an InputHandler or something else.

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

DEFAULT_SCANNER, logger, restart, UNNAMED_ERROR

Constructor Summary

Constructors

Constructor	Description
TextInputModule(TextInputModule.Builder builder)	Constructs a new TextInputModule given a builder.

Method Summary

Modifier and Type	Method	Description
static TextInputModule.Builder	builder(String name, String displayText)	Constructs a new TextInputModule builder.
void	doRunLogic()	Displays the displayText given in the constructor for TextInputModule.Builder, collects input from the scanner given in TUIModule.Builder.scanner(Scanner) then updates the application it's tied to store the input (This can be accessed via ApplicationModule.getInput(String)).
String	getInput()	Retrieve the input collected on doRunLogic().
boolean	structuralEquals(TextInputModule other)	Checks equality for properties given by the builder.

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

getAnsi, getAnsiEnabled, getApplication, getChild, getChild, getChildren, getCurrentRunningBranch, getCurrentRunningChild, getCurrentRunningChild, getName, getPrintStream, getScanner, navigateTo, restart, restartChild, shallowStructuralEquals, start, structuralEquals, terminate, terminateChild, toString, toTreeString, toTreeString

Methods inherited from class java.lang.Object

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

Field Details

INVALID

public static final String INVALID

A basic default error message if input is determined to be invalid via an InputHandler or something else.

See Also:

• Constant Field Values

Constructor Details

TextInputModule

public TextInputModule(TextInputModule.Builder builder)

Constructs a new TextInputModule given a builder. Copies displayText from the builder.

Parameters:

builder - The builder to construct the new module from.

Method Details

doRunLogic

public void doRunLogic()

Displays the displayText given in the constructor for TextInputModule.Builder, collects input from the scanner given in TUIModule.Builder.scanner(Scanner) then updates the application it's tied to store the input (This can be accessed via ApplicationModule.getInput(String)).
If InputHandlers are provided via TextInputModule.Builder.addHandler(FunctionModule.Builder) or a corresponding method, those are run immediately after this.

Specified by:

doRunLogic in class TUIModule

getInput

public String getInput()

Retrieve the input collected on doRunLogic(). Alternatively, this can be collected via ApplicationModule.getInput(String), or ApplicationModule.getInput(String, Class) with the class set to String.class.

Returns:

The string collected when running. Null if this module hasn't run yet.

structuralEquals

public boolean structuralEquals(TextInputModule other)

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

builder

public static TextInputModule.Builder builder(String name,
 String displayText)

Constructs a new TextInputModule builder.

Parameters:

name - The name of the builder.

displayText - The text that displays before getting input (e.g., "Your Input: ").

Returns:

The new builder.