org.beryx.textio

Class InputReader<T,B extends InputReader<T,B>>

java.lang.Object

org.beryx.textio.InputReader<T,B>

Type Parameters:

T - the type of the values that can be read by this InputReader

B - the type of this InputReader

Direct Known Subclasses:

BooleanInputReader, ComparableInputReader, EnumInputReader, GenericInputReader, StringInputReader

public abstract class InputReader<T,B extends InputReader<T,B>>
extends Object

A reader for values of type T. It offers a fluent interface for configuring various settings such as input masking, possible values, default value, error messages etc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	InputReader.ErrorMessageProvider Functional interface for providing error messages
static class	InputReader.ParseResult<T> A holder object returned by the parse(String) method, containing the parsed value and/or the error messages.

Field Summary

Fields

Modifier and Type	Field and Description
protected T	defaultValue null, if there is no default value
protected InputReader.ErrorMessageProvider	errorMessageProvider The provider of error messages.
protected boolean	inputMasking If true, the input will be masked (useful for example when reading passwords)
protected boolean	inputTrimming If true, the input will be trimmed.
protected boolean	numberedPossibleValues If true, the list of possible values will be numbered and the desired value will be selected by choosing the corresponding number.
protected List<T>	possibleValues Non-null and non-empty, if the value to be read must be chosen from a list of allowed values.
protected String	propertyName The name of the property corresponding to the value to be read.
protected Supplier<TextTerminal>	textTerminalSupplier Supplier of s
protected Function<T,String>	valueFormatter The formatter used when displaying values of type T.

Constructor Summary

Constructors

Constructor and Description
InputReader(Supplier<TextTerminal> textTerminalSupplier)

Method Summary

Modifier and Type	Method and Description
void	checkConfiguration() Checks if the reader is correctly configured.
protected String	getDefaultErrorMessage() Returns a generic error message.
protected List<String>	getDefaultErrorMessage(String s) If no errorMessageProvider exists, this method is used to provide the list of error messages for the input string s.
List<String>	getErrorMessage(String s) Provides the list of error messages for the input string s.
abstract InputReader.ParseResult<T>	parse(String s) Parses the input string
protected void	printPrompt(List<String> prompt, TextTerminal textTerminal, List<T> options) Displays a prompt inviting the user to enter a value.
T	read(List<String> prompt) Reads a value of type T.
T	read(String... prompt) Reads a value of type T.
B	withDefaultValue(T defaultValue)
B	withErrorMessageProvider(InputReader.ErrorMessageProvider errorMessageProvider)
B	withInputMasking(boolean inputMasking)
B	withInputTrimming(boolean inputTrimming)
B	withNumberedPossibleValues(boolean numbered)
B	withPossibleValues(List<T> possibleValues)
B	withPossibleValues(T... possibleValues)
B	withPropertyName(String propertyName)
B	withValueFormatter(Function<T,String> valueFormatter)

Methods inherited from class java.lang.Object

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

Field Detail

textTerminalSupplier

protected final Supplier<TextTerminal> textTerminalSupplier

Supplier of s

defaultValue

protected T defaultValue

null, if there is no default value

possibleValues

protected List<T> possibleValues

Non-null and non-empty, if the value to be read must be chosen from a list of allowed values.

numberedPossibleValues

protected boolean numberedPossibleValues

If true, the list of possible values will be numbered and the desired value will be selected by choosing the corresponding number.

errorMessageProvider

protected InputReader.ErrorMessageProvider errorMessageProvider

The provider of error messages. If null, the getDefaultErrorMessage(String) will be used.

propertyName

protected String propertyName

The name of the property corresponding to the value to be read. May be null.

inputMasking

protected boolean inputMasking

If true, the input will be masked (useful for example when reading passwords)

inputTrimming

protected boolean inputTrimming

If true, the input will be trimmed. Default: true

valueFormatter

protected Function<T,String> valueFormatter

The formatter used when displaying values of type T. Default: use String.valueOf(Object)

Constructor Detail

InputReader

public InputReader(Supplier<TextTerminal> textTerminalSupplier)

Method Detail

parse

public abstract InputReader.ParseResult<T> parse(String s)

Parses the input string

Parameters:

s - the input string

Returns:

a InputReader.ParseResult that holds the parsed value and/or the error messages, if errors occurred.

withDefaultValue

public B withDefaultValue(T defaultValue)

withPossibleValues

public B withPossibleValues(T... possibleValues)

withPossibleValues

public B withPossibleValues(List<T> possibleValues)

withNumberedPossibleValues

public B withNumberedPossibleValues(boolean numbered)

withInputMasking

public B withInputMasking(boolean inputMasking)

withInputTrimming

public B withInputTrimming(boolean inputTrimming)

withPropertyName

public B withPropertyName(String propertyName)

withValueFormatter

public B withValueFormatter(Function<T,String> valueFormatter)

withErrorMessageProvider

public B withErrorMessageProvider(InputReader.ErrorMessageProvider errorMessageProvider)

getDefaultErrorMessage

protected String getDefaultErrorMessage()

Returns a generic error message.

getDefaultErrorMessage

protected List<String> getDefaultErrorMessage(String s)

If no errorMessageProvider exists, this method is used to provide the list of error messages for the input string s. It should return a non-empty list of messages.

getErrorMessage

public final List<String> getErrorMessage(String s)

Provides the list of error messages for the input string s. If an errorMessageProvider exists, it will be used. Otherwise, getDefaultErrorMessage(String) will be called.

read

public T read(String... prompt)

Reads a value of type T. It repeatedly prompts the users to enter the value, until they provide a valid input string.

Parameters:

prompt - the messages to be displayed for prompting the user to enter the value

Returns:

the value of type T parsed from the input string

read

public T read(List<String> prompt)

Reads a value of type T. It repeatedly prompts the user to enter a value, until a valid input string is provided.

Parameters:

prompt - the list of messages to be displayed for prompting the user to enter the value

Returns:

the value of type T parsed from the input string

checkConfiguration

public void checkConfiguration()
                        throws IllegalArgumentException

Checks if the reader is correctly configured. This default implementation checks if the defaultValue is among the possibleValues.

Throws:

IllegalArgumentException

printPrompt

protected void printPrompt(List<String> prompt,
                           TextTerminal textTerminal,
                           List<T> options)

Displays a prompt inviting the user to enter a value.

Parameters:

prompt - the list of prompt messages. May be null.

textTerminal - the text terminal to which the messages are sent.

options - the list of options from which the user can choose a value. May be null.