Package org.springframework.shell.component.flow

Class BaseMultiItemSelector

java.lang.Object

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

org.springframework.shell.component.flow.BaseMultiItemSelector

All Implemented Interfaces:

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

Direct Known Subclasses:

DefaultMultiInputSpec

public abstract class BaseMultiItemSelector
extends BaseInput<MultiItemSelectorSpec>
implements MultiItemSelectorSpec

Base impl for MultiItemSelectorSpec.

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
ComponentFlow.Builder	and()	Build and return parent builder.
Comparator<SelectorItem<String>>	getComparator()
Integer	getMaxItems()
String	getName()
Function<MultiItemSelector.MultiItemSelectorContext<String,SelectorItem<String>>,String>	getNext()
List<Consumer<MultiItemSelector.MultiItemSelectorContext<String,SelectorItem<String>>>>	getPostHandlers()
List<Consumer<MultiItemSelector.MultiItemSelectorContext<String,SelectorItem<String>>>>	getPreHandlers()
Function<MultiItemSelector.MultiItemSelectorContext<String,SelectorItem<String>>,List<org.jline.utils.AttributedString>>	getRenderer()
ResultMode	getResultMode()
List<String>	getResultValues()
List<SelectItem>	getSelectItems()
String	getTemplateLocation()
MultiItemSelectorSpec	getThis()	Usual this trick to get typed child.
boolean	isStoreResult()
MultiItemSelectorSpec	max(int max)	Sets a maximum number of items in a selector list;
MultiItemSelectorSpec	name(String name)	Sets a name.
MultiItemSelectorSpec	next(Function<MultiItemSelector.MultiItemSelectorContext<String,SelectorItem<String>>,String> next)	Define a function which may return id of a next component to go.
MultiItemSelectorSpec	postHandler(Consumer<MultiItemSelector.MultiItemSelectorContext<String,SelectorItem<String>>> handler)	Adds a post-run context handler.
MultiItemSelectorSpec	preHandler(Consumer<MultiItemSelector.MultiItemSelectorContext<String,SelectorItem<String>>> handler)	Adds a pre-run context handler.
MultiItemSelectorSpec	renderer(Function<MultiItemSelector.MultiItemSelectorContext<String,SelectorItem<String>>,List<org.jline.utils.AttributedString>> renderer)	Sets a renderer function.
MultiItemSelectorSpec	resultMode(ResultMode resultMode)	Sets a result mode.
MultiItemSelectorSpec	resultValues(List<String> resultValues)	Sets a result values.
MultiItemSelectorSpec	selectItems(List<SelectItem> selectItems)	Adds a list of select items.
MultiItemSelectorSpec	sort(Comparator<SelectorItem<String>> comparator)	Sets a Comparator for sorting items.
MultiItemSelectorSpec	storeResult(boolean store)	Automatically stores result from a MultiItemSelector.MultiItemSelectorContext into ComponentContext with key given to builder.
MultiItemSelectorSpec	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

BaseMultiItemSelector

public BaseMultiItemSelector(ComponentFlow.BaseBuilder builder,
 String id)

Method Details

name

public MultiItemSelectorSpec name(String name)

Description copied from interface: MultiItemSelectorSpec

Sets a name.

Specified by:

name in interface MultiItemSelectorSpec

Parameters:

name - the name

Returns:

a builder

resultValues

public MultiItemSelectorSpec resultValues(List<String> resultValues)

Description copied from interface: MultiItemSelectorSpec

Sets a result values.

Specified by:

resultValues in interface MultiItemSelectorSpec

Parameters:

resultValues - the result values

Returns:

a builder

resultMode

public MultiItemSelectorSpec resultMode(ResultMode resultMode)

Description copied from interface: MultiItemSelectorSpec

Sets a result mode.

Specified by:

resultMode in interface MultiItemSelectorSpec

Parameters:

resultMode - the result mode

Returns:

a builder

selectItems

public MultiItemSelectorSpec selectItems(List<SelectItem> selectItems)

Description copied from interface: MultiItemSelectorSpec

Adds a list of select items.

Specified by:

selectItems in interface MultiItemSelectorSpec

Parameters:

selectItems - the select items

Returns:

a builder

sort

public MultiItemSelectorSpec sort(Comparator<SelectorItem<String>> comparator)

Description copied from interface: MultiItemSelectorSpec

Sets a Comparator for sorting items.

Specified by:

sort in interface MultiItemSelectorSpec

Parameters:

comparator - the item comparator

Returns:

a builder

renderer

public MultiItemSelectorSpec renderer(Function<MultiItemSelector.MultiItemSelectorContext<String,SelectorItem<String>>,List<org.jline.utils.AttributedString>> renderer)

Description copied from interface: MultiItemSelectorSpec

Sets a renderer function.

Specified by:

renderer in interface MultiItemSelectorSpec

Parameters:

renderer - the renderer

Returns:

a builder

template

public MultiItemSelectorSpec template(String location)

Description copied from interface: MultiItemSelectorSpec

Sets a default renderer template location.

Specified by:

template in interface MultiItemSelectorSpec

Parameters:

location - the template location

Returns:

a builder

max

public MultiItemSelectorSpec max(int max)

Description copied from interface: MultiItemSelectorSpec

Sets a maximum number of items in a selector list;

Specified by:

max in interface MultiItemSelectorSpec

Parameters:

max - the maximum number of items

Returns:

a builder

preHandler

public MultiItemSelectorSpec preHandler(Consumer<MultiItemSelector.MultiItemSelectorContext<String,SelectorItem<String>>> handler)

Description copied from interface: MultiItemSelectorSpec

Adds a pre-run context handler.

Specified by:

preHandler in interface MultiItemSelectorSpec

Parameters:

handler - the context handler

Returns:

a builder

postHandler

public MultiItemSelectorSpec postHandler(Consumer<MultiItemSelector.MultiItemSelectorContext<String,SelectorItem<String>>> handler)

Description copied from interface: MultiItemSelectorSpec

Adds a post-run context handler.

Specified by:

postHandler in interface MultiItemSelectorSpec

Parameters:

handler - the context handler

Returns:

a builder

storeResult

public MultiItemSelectorSpec storeResult(boolean store)

Description copied from interface: MultiItemSelectorSpec

Automatically stores result from a MultiItemSelector.MultiItemSelectorContext into ComponentContext with key given to builder. Defaults to true.

Specified by:

storeResult in interface MultiItemSelectorSpec

Parameters:

store - the flag if storing result

Returns:

a builder

next

public MultiItemSelectorSpec next(Function<MultiItemSelector.MultiItemSelectorContext<String,SelectorItem<String>>,String> next)

Description copied from interface: MultiItemSelectorSpec

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 MultiItemSelectorSpec

Parameters:

next - next component function

Returns:

a builder

and

public ComponentFlow.Builder and()

Description copied from interface: MultiItemSelectorSpec

Build and return parent builder.

Specified by:

and in interface MultiItemSelectorSpec

Returns:

the parent builder

getThis

public MultiItemSelectorSpec getThis()

Description copied from interface: BaseInputSpec

Usual this trick to get typed child.

Specified by:

getThis in interface BaseInputSpec<MultiItemSelectorSpec>

Returns:

a builder

getName

public String getName()

getResultValues

public List<String> getResultValues()

getResultMode

public ResultMode getResultMode()

getSelectItems

public List<SelectItem> getSelectItems()

getComparator

public Comparator<SelectorItem<String>> getComparator()

getRenderer

public Function<MultiItemSelector.MultiItemSelectorContext<String,SelectorItem<String>>,List<org.jline.utils.AttributedString>> getRenderer()

getTemplateLocation

public String getTemplateLocation()

getMaxItems

public Integer getMaxItems()

getPreHandlers

public List<Consumer<MultiItemSelector.MultiItemSelectorContext<String,SelectorItem<String>>>> getPreHandlers()

getPostHandlers

public List<Consumer<MultiItemSelector.MultiItemSelectorContext<String,SelectorItem<String>>>> getPostHandlers()

isStoreResult

public boolean isStoreResult()

getNext

public Function<MultiItemSelector.MultiItemSelectorContext<String,SelectorItem<String>>,String> getNext()