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

Interface NumberInputSpec

All Superinterfaces:

BaseInputSpec<NumberInputSpec>

All Known Implementing Classes:

BaseNumberInput, DefaultNumberInputSpec

public interface NumberInputSpec
extends BaseInputSpec<NumberInputSpec>

Interface for number input spec builder.

Author:

Nicola Di Falco

Method Summary

Modifier and Type	Method	Description
ComponentFlow.Builder	and()	Build and return parent builder.
NumberInputSpec	defaultValue(Number defaultValue)	Sets a default value.
NumberInputSpec	name(String name)	Sets a name.
NumberInputSpec	next(Function<NumberInput.NumberInputContext,String> next)	Define a function which may return id of a next component to go.
NumberInputSpec	numberClass(Class<? extends Number> clazz)	Sets the class of the number.
NumberInputSpec	postHandler(Consumer<NumberInput.NumberInputContext> handler)	Adds a post-run context handler.
NumberInputSpec	preHandler(Consumer<NumberInput.NumberInputContext> handler)	Adds a pre-run context handler.
NumberInputSpec	renderer(Function<NumberInput.NumberInputContext,List<org.jline.utils.AttributedString>> renderer)	Sets a renderer function.
NumberInputSpec	required()	Sets input to required
NumberInputSpec	resultMode(ResultMode resultMode)	Sets a result mode.
NumberInputSpec	resultValue(Number resultValue)	Sets a result value.
NumberInputSpec	storeResult(boolean store)	Automatically stores result from a NumberInput.NumberInputContext into ComponentContext with key given to builder.
NumberInputSpec	template(String location)	Sets a default renderer template location.

Methods inherited from interface org.springframework.shell.jline.tui.component.flow.BaseInputSpec

getThis, order

Method Details

name

NumberInputSpec name(String name)

Sets a name.

Parameters:

name - the name

Returns:

a builder

resultValue

NumberInputSpec resultValue(Number resultValue)

Sets a result value.

Parameters:

resultValue - the result value

Returns:

a builder

resultMode

NumberInputSpec resultMode(ResultMode resultMode)

Sets a result mode.

Parameters:

resultMode - the result mode

Returns:

a builder

defaultValue

NumberInputSpec defaultValue(Number defaultValue)

Sets a default value.

Parameters:

defaultValue - the defult value

Returns:

a builder

numberClass

NumberInputSpec numberClass(Class<? extends Number> clazz)

Sets the class of the number. Defaults to Integer.

Parameters:

clazz - the specific number class

Returns:

a builder

required

NumberInputSpec required()

Sets input to required

Returns:

a builder

renderer

NumberInputSpec renderer(Function<NumberInput.NumberInputContext,List<org.jline.utils.AttributedString>> renderer)

Sets a renderer function.

Parameters:

renderer - the renderer

Returns:

a builder

template

NumberInputSpec template(String location)

Sets a default renderer template location.

Parameters:

location - the template location

Returns:

a builder

preHandler

NumberInputSpec preHandler(Consumer<NumberInput.NumberInputContext> handler)

Adds a pre-run context handler.

Parameters:

handler - the context handler

Returns:

a builder

postHandler

NumberInputSpec postHandler(Consumer<NumberInput.NumberInputContext> handler)

Adds a post-run context handler.

Parameters:

handler - the context handler

Returns:

a builder

storeResult

NumberInputSpec storeResult(boolean store)

Automatically stores result from a NumberInput.NumberInputContext into ComponentContext with key given to builder. Defaults to true.

Parameters:

store - the flag if storing result

Returns:

a builder

next

NumberInputSpec next(Function<NumberInput.NumberInputContext,String> next)

Define a function which may return id of a next component to go. Returning a null or non existent id indicates that flow should stop.

Parameters:

next - next component function

Returns:

a builder

and

ComponentFlow.Builder and()

Build and return parent builder.

Returns:

the parent builder