org.springframework.shell.component.flow

Interface MultiItemSelectorSpec

All Superinterfaces:

BaseInputSpec<MultiItemSelectorSpec>

All Known Implementing Classes:

BaseMultiItemSelector, DefaultMultiInputSpec

public interface MultiItemSelectorSpec
extends BaseInputSpec<MultiItemSelectorSpec>

Interface for multi input spec builder.

Author:

Janne Valkealahti

Method Summary

Modifier and Type	Method and Description
ComponentFlow.Builder	and() Build and return parent builder.
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 interface org.springframework.shell.component.flow.BaseInputSpec

getThis, order

Method Detail

name

MultiItemSelectorSpec name(String name)

Sets a name.

Parameters:

name - the name

Returns:

a builder

resultValues

MultiItemSelectorSpec resultValues(List<String> resultValues)

Sets a result values.

Parameters:

resultValues - the result values

Returns:

a builder

resultMode

MultiItemSelectorSpec resultMode(ResultMode resultMode)

Sets a result mode.

Parameters:

resultMode - the result mode

Returns:

a builder

selectItems

MultiItemSelectorSpec selectItems(List<SelectItem> selectItems)

Adds a list of select items.

Parameters:

selectItems - the select items

Returns:

a builder

sort

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

Sets a Comparator for sorting items.

Parameters:

comparator - the item comparator

Returns:

a builder

renderer

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

Sets a renderer function.

Parameters:

renderer - the renderer

Returns:

a builder

template

MultiItemSelectorSpec template(String location)

Sets a default renderer template location.

Parameters:

location - the template location

Returns:

a builder

max

MultiItemSelectorSpec max(int max)

Sets a maximum number of items in a selector list;

Parameters:

max - the maximum number of items

Returns:

a builder

preHandler

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

Adds a pre-run context handler.

Parameters:

handler - the context handler

Returns:

a builder

postHandler

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

Adds a post-run context handler.

Parameters:

handler - the context handler

Returns:

a builder

storeResult

MultiItemSelectorSpec storeResult(boolean store)

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

Parameters:

store - the flag if storing result

Returns:

a builder

next

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

Define a function which may return id of a next component to go.

Parameters:

next - next component function

Returns:

a builder

and

ComponentFlow.Builder and()

Build and return parent builder.

Returns:

the parent builder