org.beryx.textio

Class ComparableInputReader<T extends Comparable<T>,B extends ComparableInputReader<T,B>>

java.lang.Object

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

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

Direct Known Subclasses:

DoubleInputReader, IntInputReader, LongInputReader

public abstract class ComparableInputReader<T extends Comparable<T>,B extends ComparableInputReader<T,B>>
extends InputReader<T,B>

A reader for values of y type that implements Comparable. Allows configuring the minimum and maximum permitted values.

Nested Class Summary

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

InputReader.ErrorMessageProvider, InputReader.ParseResult<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected T	maxVal
protected T	minVal

Fields inherited from class org.beryx.textio.InputReader

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

Constructor Summary

Constructors

Constructor and Description
ComparableInputReader(Supplier<TextTerminal> textTerminalSupplier)

Method Summary

Modifier and Type	Method and Description
void	checkConfiguration() In addition to the checks performed by InputReader.checkConfiguration(), it checks if minVal <= defaultVal <= maxVal
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.
boolean	isInRange(T val) Returns true if minVal <= val <= maxVal
protected abstract String	typeNameWithIndefiniteArticle()
B	withMaxVal(T maxVal) Configures the maximum allowed value
B	withMinVal(T minVal) Configures the minimum allowed value

Methods inherited from class org.beryx.textio.InputReader

getDefaultErrorMessage, getErrorMessage, parse, 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

Field Detail

minVal

protected T extends Comparable<T> minVal

maxVal

protected T extends Comparable<T> maxVal

Constructor Detail

ComparableInputReader

public ComparableInputReader(Supplier<TextTerminal> textTerminalSupplier)

Method Detail

typeNameWithIndefiniteArticle

protected abstract String typeNameWithIndefiniteArticle()

withMinVal

public B withMinVal(T minVal)

Configures the minimum allowed value

withMaxVal

public B withMaxVal(T maxVal)

Configures the maximum allowed value

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<T extends Comparable<T>,B extends ComparableInputReader<T,B>>

checkConfiguration

public void checkConfiguration()
                        throws IllegalArgumentException

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

Overrides:

checkConfiguration in class InputReader<T extends Comparable<T>,B extends ComparableInputReader<T,B>>

Throws:

IllegalArgumentException

isInRange

public boolean isInRange(T val)

Returns true if minVal <= val <= maxVal