Package org.springframework.shell.component.flow

Class BasePathInput

java.lang.Object

org.springframework.shell.component.flow.BaseInput<PathInputSpec>

org.springframework.shell.component.flow.BasePathInput

All Implemented Interfaces:

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

Direct Known Subclasses:

DefaultPathInputSpec

public abstract class BasePathInput
extends BaseInput<PathInputSpec>
implements PathInputSpec

Base impl for PathInputSpec.

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
BasePathInput(ComponentFlow.BaseBuilder builder, String id)

Method Summary

Modifier and Type	Method	Description
ComponentFlow.Builder	and()	Build and return parent builder.
PathInputSpec	defaultValue(String defaultValue)	Sets a default value.
String	getDefaultValue()
String	getName()
Function<PathInput.PathInputContext,String>	getNext()
List<Consumer<PathInput.PathInputContext>>	getPostHandlers()
List<Consumer<PathInput.PathInputContext>>	getPreHandlers()
Function<PathInput.PathInputContext,List<org.jline.utils.AttributedString>>	getRenderer()
ResultMode	getResultMode()
String	getResultValue()
String	getTemplateLocation()
PathInputSpec	getThis()	Usual this trick to get typed child.
boolean	isStoreResult()
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 class org.springframework.shell.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.component.flow.BaseInputSpec

order

Constructor Details

BasePathInput

public BasePathInput(ComponentFlow.BaseBuilder builder,
 String id)

Method Details

name

public PathInputSpec name(String name)

Description copied from interface: PathInputSpec

Sets a name.

Specified by:

name in interface PathInputSpec

Parameters:

name - the name

Returns:

a builder

resultValue

public PathInputSpec resultValue(String resultValue)

Description copied from interface: PathInputSpec

Sets a result value.

Specified by:

resultValue in interface PathInputSpec

Parameters:

resultValue - the result value

Returns:

a builder

resultMode

public PathInputSpec resultMode(ResultMode resultMode)

Description copied from interface: PathInputSpec

Sets a result mode.

Specified by:

resultMode in interface PathInputSpec

Parameters:

resultMode - the result mode

Returns:

a builder

defaultValue

public PathInputSpec defaultValue(String defaultValue)

Description copied from interface: PathInputSpec

Sets a default value.

Specified by:

defaultValue in interface PathInputSpec

Parameters:

defaultValue - the defult value

Returns:

a builder

renderer

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

Description copied from interface: PathInputSpec

Sets a renderer function.

Specified by:

renderer in interface PathInputSpec

Parameters:

renderer - the renderer

Returns:

a builder

template

public PathInputSpec template(String location)

Description copied from interface: PathInputSpec

Sets a default renderer template location.

Specified by:

template in interface PathInputSpec

Parameters:

location - the template location

Returns:

a builder

preHandler

public PathInputSpec preHandler(Consumer<PathInput.PathInputContext> handler)

Description copied from interface: PathInputSpec

Adds a pre-run context handler.

Specified by:

preHandler in interface PathInputSpec

Parameters:

handler - the context handler

Returns:

a builder

postHandler

public PathInputSpec postHandler(Consumer<PathInput.PathInputContext> handler)

Description copied from interface: PathInputSpec

Adds a post-run context handler.

Specified by:

postHandler in interface PathInputSpec

Parameters:

handler - the context handler

Returns:

a builder

storeResult

public PathInputSpec storeResult(boolean store)

Description copied from interface: PathInputSpec

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

Specified by:

storeResult in interface PathInputSpec

Parameters:

store - the flag if storing result

Returns:

a builder

next

public PathInputSpec next(Function<PathInput.PathInputContext,String> next)

Description copied from interface: PathInputSpec

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 PathInputSpec

Parameters:

next - next component function

Returns:

a builder

and

public ComponentFlow.Builder and()

Description copied from interface: PathInputSpec

Build and return parent builder.

Specified by:

and in interface PathInputSpec

Returns:

the parent builder

getThis

public PathInputSpec getThis()

Description copied from interface: BaseInputSpec

Usual this trick to get typed child.

Specified by:

getThis in interface BaseInputSpec<PathInputSpec>

Returns:

a builder

getName

public String getName()

getResultValue

public String getResultValue()

getResultMode

public ResultMode getResultMode()

getDefaultValue

public String getDefaultValue()

getRenderer

public Function<PathInput.PathInputContext,List<org.jline.utils.AttributedString>> getRenderer()

getTemplateLocation

public String getTemplateLocation()

getPreHandlers

public List<Consumer<PathInput.PathInputContext>> getPreHandlers()

getPostHandlers

public List<Consumer<PathInput.PathInputContext>> getPostHandlers()

isStoreResult

public boolean isStoreResult()

getNext

public Function<PathInput.PathInputContext,String> getNext()