org.springframework.shell.component.flow

Interface PathInputSpec

All Superinterfaces:

BaseInputSpec<PathInputSpec>

All Known Implementing Classes:

BasePathInput, DefaultPathInputSpec

public interface PathInputSpec
extends BaseInputSpec<PathInputSpec>

Interface for path input spec builder.

Author:

Janne Valkealahti

Method Summary

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

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

getThis, order

Method Detail

name

PathInputSpec name(String name)

Sets a name.

Parameters:

name - the name

Returns:

a builder

resultValue

PathInputSpec resultValue(String resultValue)

Sets a result value.

Parameters:

resultValue - the result value

Returns:

a builder

resultMode

PathInputSpec resultMode(ResultMode resultMode)

Sets a result mode.

Parameters:

resultMode - the result mode

Returns:

a builder

defaultValue

PathInputSpec defaultValue(String defaultValue)

Sets a default value.

Parameters:

defaultValue - the defult value

Returns:

a builder

renderer

PathInputSpec renderer(Function<PathInput.PathInputContext,List<org.jline.utils.AttributedString>> renderer)

Sets a renderer function.

Parameters:

renderer - the renderer

Returns:

a builder

template

PathInputSpec template(String location)

Sets a default renderer template location.

Parameters:

location - the template location

Returns:

a builder

preHandler

PathInputSpec preHandler(Consumer<PathInput.PathInputContext> handler)

Adds a pre-run context handler.

Parameters:

handler - the context handler

Returns:

a builder

postHandler

PathInputSpec postHandler(Consumer<PathInput.PathInputContext> handler)

Adds a post-run context handler.

Parameters:

handler - the context handler

Returns:

a builder

storeResult

PathInputSpec 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

PathInputSpec next(Function<PathInput.PathInputContext,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