Package com.calebleavell.textinterface.scenes

Class TextInputScene

java.lang.Object

com.calebleavell.textinterface.scenes.GenericScene

com.calebleavell.textinterface.scenes.TextInputScene

All Implemented Interfaces:

Function, Inputtable<String>, Scene

public class TextInputScene
extends GenericScene
implements Inputtable<String>

TextScene Class

Collects User Input in the Form of Text from the User

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TextInputScene.Builder

Field Summary

Fields inherited from class com.calebleavell.textinterface.scenes.GenericScene

MAX_ITERATIONS_ON_TOSTRING

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TextInputScene(TextInputScene.Builder builder)	Returns

Method Summary

Modifier and Type	Method	Description
String	getInput()	Getter for the input collected from the user
void	run()	Executes the scene by displaying the prompt, collecting the input, then running children and functions

Methods inherited from class com.calebleavell.textinterface.scenes.GenericScene

addChild, executeFunctions, getChild, getChild, getChild, getChild, getChildren, getFunctions, getID, getName, isTerminated, runChildren, setChildren, setName, terminate, toString, toString

Methods inherited from class java.lang.Object

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

Constructor Details

TextInputScene

protected TextInputScene(TextInputScene.Builder builder)

Returns

Parameters:

builder -

Method Details

getInput

public String getInput()

Description copied from interface: Inputtable

Getter for the input collected from the user

Specified by:

getInput in interface Inputtable<String>

Returns:

The user input

run

public void run()
         throws Exception

Executes the scene by displaying the prompt, collecting the input, then running children and functions

Specified by:

run in interface Function

Overrides:

run in class GenericScene

Throws:

Exception