Package org.springframework.shell.component.flow

Interface ConfirmationInputSpec

All Superinterfaces:

BaseInputSpec<ConfirmationInputSpec>

All Known Implementing Classes:

BaseConfirmationInput, DefaultConfirmationInputSpec

public interface ConfirmationInputSpec
extends BaseInputSpec<ConfirmationInputSpec>

Interface for string input spec builder.

Method Summary

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

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

getThis, order

Method Details

name

ConfirmationInputSpec name(String name)

Sets a name.

Parameters:

name - the name

Returns:

a builder

resultValue

ConfirmationInputSpec resultValue(Boolean resultValue)

Sets a result value.

Parameters:

resultValue - the result value

Returns:

a builder

resultMode

ConfirmationInputSpec resultMode(ResultMode resultMode)

Sets a result mode.

Parameters:

resultMode - the result mode

Returns:

a builder

defaultValue

ConfirmationInputSpec defaultValue(Boolean defaultValue)

Sets a default value.

Parameters:

defaultValue - the defult value

Returns:

a builder

renderer

ConfirmationInputSpec renderer(Function<ConfirmationInput.ConfirmationInputContext,List<org.jline.utils.AttributedString>> renderer)

Sets a renderer function.

Parameters:

renderer - the renderer

Returns:

a builder

template

ConfirmationInputSpec template(String location)

Sets a default renderer template location.

Parameters:

location - the template location

Returns:

a builder

preHandler

ConfirmationInputSpec preHandler(Consumer<ConfirmationInput.ConfirmationInputContext> handler)

Adds a pre-run context handler.

Parameters:

handler - the context handler

Returns:

a builder

postHandler

ConfirmationInputSpec postHandler(Consumer<ConfirmationInput.ConfirmationInputContext> handler)

Adds a post-run context handler.

Parameters:

handler - the context handler

Returns:

a builder

storeResult

ConfirmationInputSpec storeResult(boolean store)

Automatically stores result from a ConfirmationInput.ConfirmationInputContext into ComponentContext with key given to builder. Defaults to true.

Parameters:

store - the flag if storing result

Returns:

a builder

next

ConfirmationInputSpec next(Function<ConfirmationInput.ConfirmationInputContext,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