InputReader (text-io Documentation (2.8.0))

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.ErrorMessagesProvider` 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.
`static interface`	`InputReader.ValueChecker<T>` Functional interface for checking value constraints

Field Summary

Fields
Modifier and Type	Field and Description
`protected T`	`defaultValue` null, if there is no default value
`protected BiFunction<T,T,Boolean>`	`equalsFunc` The function used to check whether two values are equal.
`protected boolean`	`inlinePossibleValues` If true, the list of possible values will be displayed on a single line.
`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 String`	`itemName` The name of the item corresponding to the value to be read.
`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 InputReader.ErrorMessagesProvider`	`parseErrorMessagesProvider` The provider of parse error messages.
`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 boolean`	`promptAdjustments` If true, the input reader is allowed to tweak the prompter, for example by including the default value or appending a colon at the end.
`protected Supplier<TextTerminal>`	`textTerminalSupplier` Supplier of s
`protected List<InputReader.ValueChecker<T>>`	`valueCheckers` The list of value checkers used to detect constraint violations
`protected Function<T,String>`	`valueFormatter` The formatter used when displaying values of type T.
`protected List<InputReader.ValueChecker<List<T>>>`	`valueListCheckers` The list of value checkers used to detect constraint violations for a list of values

Constructor Summary

Constructors
Constructor and Description

InputReader(Supplier<TextTerminal> textTerminalSupplier)

Constructors
Constructor and Description
`InputReader(Supplier<TextTerminal> textTerminalSupplier)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`checkConfiguration()` Checks if the reader is correctly configured.
`protected String`	`getDefaultErrorMessage(String sVal)` Returns a generic error message.
`protected List<String>`	`getDefaultErrorMessages(String s)` If no `parseErrorMessagesProvider` exists, this method is used to provide the list of error messages for the input string `s`.
`protected List<String>`	`getErrorMessages(String s)` Provides the list of error messages for the input string `s`.
`protected Optional<T>`	`getPossibleValue(T val)`
`protected boolean`	`isPossibleValue(T val)`
`boolean`	`isValueListMode()`
`static <T> InputReader.ValueChecker<List<T>>`	`noDuplicatesChecker()`
`static <T> InputReader.ValueChecker<List<T>>`	`nonEmptyListChecker()`
`protected abstract InputReader.ParseResult<T>`	`parse(String s)` Parses the input string
`protected InputReader.ParseResult<T>`	`parseAndCheck(String s)` Parses the input string and runs all value checkers in order to find constraint violations.
`protected void`	`printPrompt(List<String> prompt, TextTerminal textTerminal)` 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.
`List<T>`	`readList(List<String> prompt)`
`List<T>`	`readList(String... prompt)`
`B`	`withDefaultValue(T defaultValue)`
`B`	`withEqualsFunc(BiFunction<T,T,Boolean> equalsFunc)`
`B`	`withInlinePossibleValues(List<T> possibleValues)`
`B`	`withInlinePossibleValues(T... possibleValues)`
`B`	`withInputMasking(boolean inputMasking)`
`B`	`withInputTrimming(boolean inputTrimming)`
`B`	`withItemName(String itemName)`
`B`	`withNumberedPossibleValues(List<T> possibleValues)`
`B`	`withNumberedPossibleValues(T... possibleValues)`
`B`	`withParseErrorMessagesProvider(InputReader.ErrorMessagesProvider parseErrorMessagesProvider)`
`B`	`withPossibleValues(List<T> possibleValues)`
`B`	`withPossibleValues(T... possibleValues)`
`B`	`withPromptAdjustments(boolean promptAdjustment)`
`B`	`withValueChecker(InputReader.ValueChecker<T> valueChecker)` Adds the valueChecker passed as argument.
`B`	`withValueFormatter(Function<T,String> valueFormatter)`
`B`	`withValueListChecker(InputReader.ValueChecker<List<T>> valueListChecker)` Adds the valueListChecker passed as argument.

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.
  - inlinePossibleValues
```
protected boolean inlinePossibleValues
```
    If true, the list of possible values will be displayed on a single line.
  - parseErrorMessagesProvider
```
protected InputReader.ErrorMessagesProvider parseErrorMessagesProvider
```
    The provider of parse error messages. If null, the getDefaultErrorMessages(String) will be used.
  - itemName
```
protected String itemName
```
    The name of the item 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
  - promptAdjustments
```
protected boolean promptAdjustments
```
    If true, the input reader is allowed to tweak the prompter, for example by including the default value or appending a colon at the end. Default: true
  - valueCheckers
```
protected final List<InputReader.ValueChecker<T>> valueCheckers
```
    The list of value checkers used to detect constraint violations
  - valueListCheckers
```
protected final List<InputReader.ValueChecker<List<T>>> valueListCheckers
```
    The list of value checkers used to detect constraint violations for a list of values
  - valueFormatter
```
protected Function<T,String> valueFormatter
```
    The formatter used when displaying values of type T. Default: use String.valueOf(Object)
  - equalsFunc
```
protected BiFunction<T,T,Boolean> equalsFunc
```
    The function used to check whether two values are equal. Default: Objects.equals(Object, Object)
- Constructor Detail
  - InputReader
```
public InputReader(Supplier<TextTerminal> textTerminalSupplier)
```
- Method Detail
  - parse
```
protected 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(T... possibleValues)
```
  - withNumberedPossibleValues
```
public B withNumberedPossibleValues(List<T> possibleValues)
```
  - withInlinePossibleValues
```
public B withInlinePossibleValues(T... possibleValues)
```
  - withInlinePossibleValues
```
public B withInlinePossibleValues(List<T> possibleValues)
```
  - withInputMasking
```
public B withInputMasking(boolean inputMasking)
```
  - withInputTrimming
```
public B withInputTrimming(boolean inputTrimming)
```
  - withPromptAdjustments
```
public B withPromptAdjustments(boolean promptAdjustment)
```
  - withItemName
```
public B withItemName(String itemName)
```
  - withValueFormatter
```
public B withValueFormatter(Function<T,String> valueFormatter)
```
  - withEqualsFunc
```
public B withEqualsFunc(BiFunction<T,T,Boolean> equalsFunc)
```
  - withParseErrorMessagesProvider
```
public B withParseErrorMessagesProvider(InputReader.ErrorMessagesProvider parseErrorMessagesProvider)
```
  - withValueChecker
```
public B withValueChecker(InputReader.ValueChecker<T> valueChecker)
```
    Adds the valueChecker passed as argument. May be called multiple times.
  - withValueListChecker
```
public B withValueListChecker(InputReader.ValueChecker<List<T>> valueListChecker)
```
    Adds the valueListChecker passed as argument. May be called multiple times.
  - isValueListMode
```
public boolean isValueListMode()
```
    Returns:
    
    true, if currently reading a list of values via readList(List)
  - getDefaultErrorMessage
```
protected String getDefaultErrorMessage(String sVal)
```
    Returns a generic error message.
  - getDefaultErrorMessages
```
protected List<String> getDefaultErrorMessages(String s)
```
    If no parseErrorMessagesProvider 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.
  - getErrorMessages
```
protected final List<String> getErrorMessages(String s)
```
    Provides the list of error messages for the input string s. If a parseErrorMessagesProvider exists, it will be used. Otherwise, getDefaultErrorMessages(String) will be called.
  - parseAndCheck
```
protected InputReader.ParseResult<T> parseAndCheck(String s)
```
    Parses the input string and runs all value checkers in order to find constraint violations.
    
    Parameters:
    
    s - the input string
    
    Returns:
    
    a InputReader.ParseResult that holds the parsed value and/or the error messages, if errors occurred.
  - 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
  - readList
```
public List<T> readList(String... prompt)
```
  - readList
```
public List<T> readList(List<String> prompt)
```
  - isPossibleValue
```
protected boolean isPossibleValue(T val)
```
  - getPossibleValue
```
protected Optional<T> getPossibleValue(T val)
```
  - checkConfiguration
```
protected 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)
```
    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.
  - nonEmptyListChecker
```
public static <T> InputReader.ValueChecker<List<T>> nonEmptyListChecker()
```
  - noDuplicatesChecker
```
public static <T> InputReader.ValueChecker<List<T>> noDuplicatesChecker()
```

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

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

textTerminalSupplier

defaultValue

possibleValues

numberedPossibleValues

inlinePossibleValues

parseErrorMessagesProvider

itemName

inputMasking

inputTrimming

promptAdjustments

valueCheckers

valueListCheckers

valueFormatter

equalsFunc

Constructor Detail

InputReader

Method Detail

parse

withDefaultValue

withPossibleValues

withPossibleValues

withNumberedPossibleValues

withNumberedPossibleValues

withInlinePossibleValues

withInlinePossibleValues

withInputMasking

withInputTrimming

withPromptAdjustments

withItemName

withValueFormatter

withEqualsFunc

withParseErrorMessagesProvider

withValueChecker

withValueListChecker

isValueListMode

getDefaultErrorMessage

getDefaultErrorMessages

getErrorMessages

parseAndCheck

read

read

readList

readList

isPossibleValue

getPossibleValue

checkConfiguration

printPrompt

nonEmptyListChecker

noDuplicatesChecker