Package org.springframework.shell.component.flow

Interface StringInputSpec

All Superinterfaces:

BaseInputSpec<StringInputSpec>

All Known Implementing Classes:

BaseStringInput, DefaultStringInputSpec

public interface StringInputSpec
extends BaseInputSpec<StringInputSpec>

Interface for string input spec builder.

Method Summary

Modifier and Type	Method	Description
ComponentFlow.Builder	and()	Build and return parent builder.
StringInputSpec	defaultValue(String defaultValue)	Sets a default value.
StringInputSpec	maskCharacter(Character maskCharacter)	Sets a mask character.
StringInputSpec	name(String name)	Sets a name.
StringInputSpec	next(Function<StringInput.StringInputContext,String> next)	Define a function which may return id of a next component to go.
StringInputSpec	postHandler(Consumer<StringInput.StringInputContext> handler)	Adds a post-run context handler.
StringInputSpec	preHandler(Consumer<StringInput.StringInputContext> handler)	Adds a pre-run context handler.
StringInputSpec	renderer(Function<StringInput.StringInputContext,List<org.jline.utils.AttributedString>> renderer)	Sets a renderer function.
StringInputSpec	resultMode(ResultMode resultMode)	Sets a result mode.
StringInputSpec	resultValue(String resultValue)	Sets a result value.
StringInputSpec	storeResult(boolean store)	Automatically stores result from a StringInput.StringInputContext into ComponentContext with key given to builder.
StringInputSpec	template(String location)	Sets a default renderer template location.

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

getThis, order

Method Details

name

StringInputSpec name(String name)

Sets a name.

Parameters:

name - the name

Returns:

a builder

resultValue

StringInputSpec resultValue(String resultValue)

Sets a result value.

Parameters:

resultValue - the result value

Returns:

a builder

resultMode

StringInputSpec resultMode(ResultMode resultMode)

Sets a result mode.

Parameters:

resultMode - the result mode

Returns:

a builder

defaultValue

StringInputSpec defaultValue(String defaultValue)

Sets a default value.

Parameters:

defaultValue - the defult value

Returns:

a builder

maskCharacter

StringInputSpec maskCharacter(Character maskCharacter)

Sets a mask character.

Parameters:

maskCharacter - the mask character

Returns:

a builder

renderer

StringInputSpec renderer(Function<StringInput.StringInputContext,List<org.jline.utils.AttributedString>> renderer)

Sets a renderer function.

Parameters:

renderer - the renderer

Returns:

a builder

template

StringInputSpec template(String location)

Sets a default renderer template location.

Parameters:

location - the template location

Returns:

a builder

preHandler

StringInputSpec preHandler(Consumer<StringInput.StringInputContext> handler)

Adds a pre-run context handler.

Parameters:

handler - the context handler

Returns:

a builder

postHandler

StringInputSpec postHandler(Consumer<StringInput.StringInputContext> handler)

Adds a post-run context handler.

Parameters:

handler - the context handler

Returns:

a builder

storeResult

StringInputSpec storeResult(boolean store)

Automatically stores result from a StringInput.StringInputContext into ComponentContext with key given to builder. Defaults to true.

Parameters:

store - the flag if storing result

Returns:

a builder

next

StringInputSpec next(Function<StringInput.StringInputContext,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