Package org.springframework.shell.jline.tui.component

Interface NumberInput.NumberInputContext

All Superinterfaces:

AbstractTextComponent.TextComponentContext<Number,NumberInput.NumberInputContext>, ComponentContext<NumberInput.NumberInputContext>

Enclosing class:

NumberInput

public static interface NumberInput.NumberInputContext
extends AbstractTextComponent.TextComponentContext<Number,NumberInput.NumberInputContext>

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.shell.jline.tui.component.support.AbstractTextComponent.TextComponentContext

AbstractTextComponent.TextComponentContext.MessageLevel

Method Summary

Modifier and Type	Method	Description
static NumberInput.NumberInputContext	empty()	Gets an empty NumberInput.NumberInputContext.
Class<? extends Number>	getDefaultClass()	Gets a default number class.
@Nullable Number	getDefaultValue()	Gets a default value.
boolean	isRequired()	Returns flag if input is required.
static NumberInput.NumberInputContext	of(@Nullable Number defaultValue)	Gets an NumberInput.NumberInputContext.
static NumberInput.NumberInputContext	of(@Nullable Number defaultValue, Class<? extends Number> defaultClass)	Gets an NumberInput.NumberInputContext.
static NumberInput.NumberInputContext	of(@Nullable Number defaultValue, Class<? extends Number> defaultClass, boolean required)	Gets an NumberInput.NumberInputContext.
void	setDefaultClass(Class<? extends Number> defaultClass)	Sets a default number class.
void	setDefaultValue(@Nullable Number defaultValue)	Sets a default value.
void	setRequired(boolean required)	Sets flag for mandatory input.

Methods inherited from interface org.springframework.shell.jline.tui.component.support.AbstractTextComponent.TextComponentContext

getInput, getMessage, getMessageLevel, getName, getResultValue, setInput, setMessage, setMessage, setMessageLevel, setName, setResultValue

Methods inherited from interface org.springframework.shell.jline.tui.component.context.ComponentContext

containsKey, get, get, getTerminalWidth, put, setTerminalWidth, stream, toTemplateModel

Method Details

getDefaultValue

@Nullable Number getDefaultValue()

Gets a default value.

Returns:

a default value

setDefaultValue

void setDefaultValue(@Nullable Number defaultValue)

Sets a default value.

Parameters:

defaultValue - the default value

getDefaultClass

Class<? extends Number> getDefaultClass()

Gets a default number class.

Returns:

a default number class

setDefaultClass

void setDefaultClass(Class<? extends Number> defaultClass)

Sets a default number class.

Parameters:

defaultClass - the default number class

setRequired

void setRequired(boolean required)

Sets flag for mandatory input.

Parameters:

required - true if input is required

isRequired

boolean isRequired()

Returns flag if input is required.

Returns:

true if input is required, false otherwise

empty

static NumberInput.NumberInputContext empty()

Gets an empty NumberInput.NumberInputContext.

Returns:

empty number input context

of

static NumberInput.NumberInputContext of(@Nullable Number defaultValue)

Gets an NumberInput.NumberInputContext.

Returns:

number input context

of

static NumberInput.NumberInputContext of(@Nullable Number defaultValue,
 Class<? extends Number> defaultClass)

Gets an NumberInput.NumberInputContext.

Returns:

number input context

of

static NumberInput.NumberInputContext of(@Nullable Number defaultValue,
 Class<? extends Number> defaultClass,
 boolean required)

Gets an NumberInput.NumberInputContext.

Returns:

number input context