Package org.strassburger.tui4j.input

Class TextInput

java.lang.Object

org.strassburger.tui4j.input.Input<String,TextInput>

org.strassburger.tui4j.input.TextInput

public class TextInput
extends Input<String,TextInput>

Constructor Summary

Constructors

Constructor	Description
TextInput()	Reads a single line of text from the console.

Method Summary

Modifier and Type	Method	Description
String	read()	Read the input value
TextInput	setInline(boolean inline)	Set whether the input should be inline or not.

Methods inherited from class org.strassburger.tui4j.input.Input

addValidationRule, addValidationRules, getCursor, getErrorMessage, getLabel, getPrinter, getScanner, isRetryOnInvalid, setCursor, setErrorMessage, setErrorMessage, setLabel, setLabel, setPrinter, setRetryOnInvalid, setScanner, validate

Methods inherited from class java.lang.Object

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

Constructor Details

TextInput

public TextInput()

Reads a single line of text from the console.

Example usage:

 String name = new TextInput()
        .setLabel("What is your name?")
        .setRetryOnInvalid(true)
        .read();
 

Method Details

read

public String read()
            throws InputValidationException

Description copied from class: Input

Read the input value

Specified by:

read in class Input<String,TextInput>

Returns:

the input value

Throws:

InputValidationException - if the input is invalid and retryOnInvalid is false

setInline

public TextInput setInline(boolean inline)

Set whether the input should be inline or not.

Parameters:

inline - Whether the input should be inline or not