-
- All Superinterfaces:
InputPrompt,Prompt
- All Known Implementing Classes:
DefaultNumberPrompt
public interface NumberPrompt extends InputPrompt
Interface for number prompts. A number prompt is like an input prompt but validates that the input is a valid number.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default booleanallowDecimals()Whether to allow decimal numbers or only integers.default java.lang.DoublegetDefaultNumber()Get the default value as a number.default java.lang.StringgetInvalidNumberMessage()Get the error message to show for invalid numbers.default java.lang.DoublegetMax()Get the maximum allowed value.default java.lang.DoublegetMin()Get the minimum allowed value.default java.lang.StringgetOutOfRangeMessage()Get the error message to show for out-of-range numbers.-
Methods inherited from interface org.jline.prompt.InputPrompt
getCompleter, getDefaultValue, getLineReader, getMask, getValidator
-
Methods inherited from interface org.jline.prompt.Prompt
getFilter, getMessage, getName, getTransformer
-
-
-
-
Method Detail
-
getMin
default java.lang.Double getMin()
Get the minimum allowed value.- Returns:
- the minimum value, or null for no minimum
-
getMax
default java.lang.Double getMax()
Get the maximum allowed value.- Returns:
- the maximum value, or null for no maximum
-
allowDecimals
default boolean allowDecimals()
Whether to allow decimal numbers or only integers.- Returns:
- true to allow decimals, false for integers only
-
getDefaultNumber
default java.lang.Double getDefaultNumber()
Get the default value as a number.- Returns:
- the default number value, or null for no default
-
getInvalidNumberMessage
default java.lang.String getInvalidNumberMessage()
Get the error message to show for invalid numbers.- Returns:
- the error message
-
getOutOfRangeMessage
default java.lang.String getOutOfRangeMessage()
Get the error message to show for out-of-range numbers.- Returns:
- the error message
-
-