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

Class BaseNumberInput

java.lang.Object

org.springframework.shell.jline.tui.component.flow.BaseInput<NumberInputSpec>

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

All Implemented Interfaces:

org.springframework.core.Ordered, BaseInputSpec<NumberInputSpec>, NumberInputSpec

Direct Known Subclasses:

DefaultNumberInputSpec

public abstract class BaseNumberInput
extends BaseInput<NumberInputSpec>
implements NumberInputSpec

Base impl for NumberInputSpec.

Author:

Nicola Di Falco

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseNumberInput(ComponentFlow.BaseBuilder builder, String id)

Method Summary

Modifier and Type	Method	Description
ComponentFlow.Builder	and()	Build and return parent builder.
NumberInputSpec	defaultValue(Number defaultValue)	Sets a default value.
@Nullable Number	getDefaultValue()
@Nullable String	getName()
@Nullable Function<NumberInput.NumberInputContext,String>	getNext()
Class<? extends Number>	getNumberClass()
List<Consumer<NumberInput.NumberInputContext>>	getPostHandlers()
List<Consumer<NumberInput.NumberInputContext>>	getPreHandlers()
@Nullable Function<NumberInput.NumberInputContext,List<org.jline.utils.AttributedString>>	getRenderer()
@Nullable ResultMode	getResultMode()
@Nullable Number	getResultValue()
@Nullable String	getTemplateLocation()
NumberInputSpec	getThis()	Usual this trick to get typed child.
boolean	isRequired()
boolean	isStoreResult()
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 class org.springframework.shell.jline.tui.component.flow.BaseInput

getBuilder, getId, getOrder, order, setOrder

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

order

Constructor Details

BaseNumberInput

protected BaseNumberInput(ComponentFlow.BaseBuilder builder,
 String id)

Method Details

name

public NumberInputSpec name(String name)

Description copied from interface: NumberInputSpec

Sets a name.

Specified by:

name in interface NumberInputSpec

Parameters:

name - the name

Returns:

a builder

resultValue

public NumberInputSpec resultValue(Number resultValue)

Description copied from interface: NumberInputSpec

Sets a result value.

Specified by:

resultValue in interface NumberInputSpec

Parameters:

resultValue - the result value

Returns:

a builder

resultMode

public NumberInputSpec resultMode(ResultMode resultMode)

Description copied from interface: NumberInputSpec

Sets a result mode.

Specified by:

resultMode in interface NumberInputSpec

Parameters:

resultMode - the result mode

Returns:

a builder

defaultValue

public NumberInputSpec defaultValue(Number defaultValue)

Description copied from interface: NumberInputSpec

Sets a default value.

Specified by:

defaultValue in interface NumberInputSpec

Parameters:

defaultValue - the defult value

Returns:

a builder

numberClass

public NumberInputSpec numberClass(Class<? extends Number> clazz)

Description copied from interface: NumberInputSpec

Sets the class of the number. Defaults to Integer.

Specified by:

numberClass in interface NumberInputSpec

Parameters:

clazz - the specific number class

Returns:

a builder

required

public NumberInputSpec required()

Description copied from interface: NumberInputSpec

Sets input to required

Specified by:

required in interface NumberInputSpec

Returns:

a builder

renderer

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

Description copied from interface: NumberInputSpec

Sets a renderer function.

Specified by:

renderer in interface NumberInputSpec

Parameters:

renderer - the renderer

Returns:

a builder

template

public NumberInputSpec template(String location)

Description copied from interface: NumberInputSpec

Sets a default renderer template location.

Specified by:

template in interface NumberInputSpec

Parameters:

location - the template location

Returns:

a builder

preHandler

public NumberInputSpec preHandler(Consumer<NumberInput.NumberInputContext> handler)

Description copied from interface: NumberInputSpec

Adds a pre-run context handler.

Specified by:

preHandler in interface NumberInputSpec

Parameters:

handler - the context handler

Returns:

a builder

postHandler

public NumberInputSpec postHandler(Consumer<NumberInput.NumberInputContext> handler)

Description copied from interface: NumberInputSpec

Adds a post-run context handler.

Specified by:

postHandler in interface NumberInputSpec

Parameters:

handler - the context handler

Returns:

a builder

storeResult

public NumberInputSpec storeResult(boolean store)

Description copied from interface: NumberInputSpec

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

Specified by:

storeResult in interface NumberInputSpec

Parameters:

store - the flag if storing result

Returns:

a builder

next

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

Description copied from interface: NumberInputSpec

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.

Specified by:

next in interface NumberInputSpec

Parameters:

next - next component function

Returns:

a builder

and

public ComponentFlow.Builder and()

Description copied from interface: NumberInputSpec

Build and return parent builder.

Specified by:

and in interface NumberInputSpec

Returns:

the parent builder

getThis

public NumberInputSpec getThis()

Description copied from interface: BaseInputSpec

Usual this trick to get typed child.

Specified by:

getThis in interface BaseInputSpec<NumberInputSpec>

Returns:

a builder

getName

public @Nullable String getName()

getResultValue

public @Nullable Number getResultValue()

getResultMode

public @Nullable ResultMode getResultMode()

getDefaultValue

public @Nullable Number getDefaultValue()

getNumberClass

public Class<? extends Number> getNumberClass()

isRequired

public boolean isRequired()

getRenderer

public @Nullable Function<NumberInput.NumberInputContext,List<org.jline.utils.AttributedString>> getRenderer()

getTemplateLocation

public @Nullable String getTemplateLocation()

getPreHandlers

public List<Consumer<NumberInput.NumberInputContext>> getPreHandlers()

getPostHandlers

public List<Consumer<NumberInput.NumberInputContext>> getPostHandlers()

isStoreResult

public boolean isStoreResult()

getNext

public @Nullable Function<NumberInput.NumberInputContext,String> getNext()