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.ErrorMessagesProvider, InputReader.ParseResult<T>, InputReader.ValueChecker<T>

Field Summary

Fields inherited from class org.beryx.textio.InputReader

defaultValue, equalsFunc, inputMasking, inputTrimming, numberedPossibleValues, parseErrorMessagesProvider, possibleValues, promptAdjustments, propertyName, textTerminalSupplier, valueCheckers, valueFormatter, valueListCheckers

Constructor Summary

Constructors

Constructor and Description
StringInputReader(Supplier<TextTerminal> textTerminalSupplier)

Method Summary

Modifier and Type	Method and Description
protected void	checkConfiguration() In addition to the checks performed by InputReader.checkConfiguration(), it checks if minVal <= maxVal
protected List<String>	getLengthValidationErrors(String s)
protected List<String>	getPatternValidationErrors(String s)
protected 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, getDefaultErrorMessages, getErrorMessages, isPossibleValue, isValueListMode, noDuplicatesChecker, nonEmptyListChecker, parseAndCheck, printPrompt, read, read, readList, readList, withDefaultValue, withEqualsFunc, withInputMasking, withInputTrimming, withNumberedPossibleValues, withParseErrorMessagesProvider, withPossibleValues, withPossibleValues, withPromptAdjustments, withPropertyName, withValueChecker, withValueFormatter, withValueListChecker

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)

parse

protected 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.

checkConfiguration

protected void checkConfiguration()
                           throws IllegalArgumentException

In addition to the checks performed by InputReader.checkConfiguration(), it checks if minVal <= maxVal

Overrides:

checkConfiguration in class InputReader<String,StringInputReader>

Throws:

IllegalArgumentException

getLengthValidationErrors

protected List<String> getLengthValidationErrors(String s)

getPatternValidationErrors

protected List<String> getPatternValidationErrors(String s)