org.beryx.textio

Class StringInputReader

java.lang.Object

org.beryx.textio.InputReader<String,StringInputReader>

org.beryx.textio.StringInputReader

public class StringInputReader
extends InputReader<String,StringInputReader>

A reader for string values. Allows configuring the minimum and maximum length, as well as a regex pattern. By default, it uses a numbered list for displaying the possible values.

Nested Class Summary

Nested classes/interfaces inherited from class org.beryx.textio.InputReader

InputReader.ErrorMessageProvider, InputReader.ParseResult<T>

Field Summary

Fields inherited from class org.beryx.textio.InputReader

defaultValue, errorMessageProvider, inputMasking, inputTrimming, numberedPossibleValues, possibleValues, propertyName, textTerminalSupplier, valueFormatter

Constructor Summary

Constructors

Constructor and Description
StringInputReader(Supplier<TextTerminal> textTerminalSupplier)

Method Summary

Modifier and Type	Method and Description
void	checkConfiguration() Checks if the reader is correctly configured.
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.
InputReader.ParseResult<String>	parse(String s) Parses the input string
StringInputReader	withMaxLength(int maxLength)
StringInputReader	withMinLength(int minLength)
StringInputReader	withPattern(String regex)
StringInputReader	withPattern(String regex, int flags)

Methods inherited from class org.beryx.textio.InputReader

getDefaultErrorMessage, getErrorMessage, printPrompt, read, read, withDefaultValue, withErrorMessageProvider, withInputMasking, withInputTrimming, withNumberedPossibleValues, withPossibleValues, withPossibleValues, withPropertyName, withValueFormatter

Methods inherited from class java.lang.Object

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

Constructor Detail

StringInputReader

public StringInputReader(Supplier<TextTerminal> textTerminalSupplier)

Method Detail

withPattern

public StringInputReader withPattern(String regex)

withPattern

public StringInputReader withPattern(String regex,
                                     int flags)

withMinLength

public StringInputReader withMinLength(int minLength)

withMaxLength

public StringInputReader withMaxLength(int maxLength)

getDefaultErrorMessage

protected List<String> getDefaultErrorMessage(String s)

Description copied from class: InputReader

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.

Overrides:

getDefaultErrorMessage in class InputReader<String,StringInputReader>

checkConfiguration

public void checkConfiguration()
                        throws IllegalArgumentException

Description copied from class: InputReader

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

Overrides:

checkConfiguration in class InputReader<String,StringInputReader>

Throws:

IllegalArgumentException

parse

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

Description copied from class: InputReader

Parses the input string

Specified by:

parse in class InputReader<String,StringInputReader>

Parameters:

s - the input string

Returns:

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