Package org.springframework.shell.tui.component.flow

Class BaseSingleItemSelector

java.lang.Object

org.springframework.shell.tui.component.flow.BaseInput<SingleItemSelectorSpec>

org.springframework.shell.tui.component.flow.BaseSingleItemSelector

All Implemented Interfaces:

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

Direct Known Subclasses:

DefaultSingleInputSpec

public abstract class BaseSingleItemSelector
extends BaseInput<SingleItemSelectorSpec>
implements SingleItemSelectorSpec

Base impl for SingleItemSelectorSpec.

Author:

Janne Valkealahti

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
ComponentFlow.Builder	and()	Build and return parent builder.
SingleItemSelectorSpec	defaultSelect(String name)	Automatically selects and exposes a given item.
Comparator<SelectorItem<String>>	getComparator()
String	getDefaultSelect()
Integer	getMaxItems()
String	getName()
Function<SingleItemSelector.SingleItemSelectorContext<String,SelectorItem<String>>,String>	getNext()
List<Consumer<SingleItemSelector.SingleItemSelectorContext<String,SelectorItem<String>>>>	getPostHandlers()
List<Consumer<SingleItemSelector.SingleItemSelectorContext<String,SelectorItem<String>>>>	getPreHandlers()
Function<SingleItemSelector.SingleItemSelectorContext<String,SelectorItem<String>>,List<org.jline.utils.AttributedString>>	getRenderer()
ResultMode	getResultMode()
String	getResultValue()
List<SelectItem>	getSelectItems()
String	getTemplateLocation()
SingleItemSelectorSpec	getThis()	Usual this trick to get typed child.
boolean	isStoreResult()
SingleItemSelectorSpec	max(int max)	Sets a maximum number of items in a selector list;
SingleItemSelectorSpec	name(String name)	Sets a name.
SingleItemSelectorSpec	next(Function<SingleItemSelector.SingleItemSelectorContext<String,SelectorItem<String>>,String> next)	Define a function which may return id of a next component to go.
SingleItemSelectorSpec	postHandler(Consumer<SingleItemSelector.SingleItemSelectorContext<String,SelectorItem<String>>> handler)	Adds a post-run context handler.
SingleItemSelectorSpec	preHandler(Consumer<SingleItemSelector.SingleItemSelectorContext<String,SelectorItem<String>>> handler)	Adds a pre-run context handler.
SingleItemSelectorSpec	renderer(Function<SingleItemSelector.SingleItemSelectorContext<String,SelectorItem<String>>,List<org.jline.utils.AttributedString>> renderer)	Sets a renderer function.
SingleItemSelectorSpec	resultMode(ResultMode resultMode)	Sets a result mode.
SingleItemSelectorSpec	resultValue(String resultValue)	Sets a result value.
SingleItemSelectorSpec	selectItem(String name, String item)	Adds a select item.
SingleItemSelectorSpec	selectItems(List<SelectItem> selectItems)	Adds a list of select items.
SingleItemSelectorSpec	selectItems(Map<String,String> selectItems)	Adds a map of select items.
SingleItemSelectorSpec	sort(Comparator<SelectorItem<String>> comparator)	Sets a Comparator for sorting items.
SingleItemSelectorSpec	storeResult(boolean store)	Automatically stores result from a SingleItemSelector.SingleItemSelectorContext into ComponentContext with key given to builder.
SingleItemSelectorSpec	template(String location)	Sets a default renderer template location.

Methods inherited from class org.springframework.shell.tui.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.tui.component.flow.BaseInputSpec

order

Constructor Details

BaseSingleItemSelector

public BaseSingleItemSelector(ComponentFlow.BaseBuilder builder,
 String id)

Method Details

name

public SingleItemSelectorSpec name(String name)

Description copied from interface: SingleItemSelectorSpec

Sets a name.

Specified by:

name in interface SingleItemSelectorSpec

Parameters:

name - the name

Returns:

a builder

resultValue

public SingleItemSelectorSpec resultValue(String resultValue)

Description copied from interface: SingleItemSelectorSpec

Sets a result value.

Specified by:

resultValue in interface SingleItemSelectorSpec

Parameters:

resultValue - the result value

Returns:

a builder

resultMode

public SingleItemSelectorSpec resultMode(ResultMode resultMode)

Description copied from interface: SingleItemSelectorSpec

Sets a result mode.

Specified by:

resultMode in interface SingleItemSelectorSpec

Parameters:

resultMode - the result mode

Returns:

a builder

selectItem

public SingleItemSelectorSpec selectItem(String name,
 String item)

Description copied from interface: SingleItemSelectorSpec

Adds a select item.

Specified by:

selectItem in interface SingleItemSelectorSpec

Parameters:

name - the name

item - the item

Returns:

a builder

See Also:

• SingleItemSelectorSpec.selectItems(List)

selectItems

public SingleItemSelectorSpec selectItems(Map<String,String> selectItems)

Description copied from interface: SingleItemSelectorSpec

Adds a map of select items.

Specified by:

selectItems in interface SingleItemSelectorSpec

Parameters:

selectItems - the select items

Returns:

a builder

See Also:

• SingleItemSelectorSpec.selectItems(List)

selectItems

public SingleItemSelectorSpec selectItems(List<SelectItem> selectItems)

Description copied from interface: SingleItemSelectorSpec

Adds a list of select items.

Specified by:

selectItems in interface SingleItemSelectorSpec

Parameters:

selectItems - the select items

Returns:

a builder

defaultSelect

public SingleItemSelectorSpec defaultSelect(String name)

Description copied from interface: SingleItemSelectorSpec

Automatically selects and exposes a given item.

Specified by:

defaultSelect in interface SingleItemSelectorSpec

Parameters:

name - the name

Returns:

a builder

sort

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

Description copied from interface: SingleItemSelectorSpec

Sets a Comparator for sorting items.

Specified by:

sort in interface SingleItemSelectorSpec

Parameters:

comparator - the item comparator

Returns:

a builder

renderer

public SingleItemSelectorSpec renderer(Function<SingleItemSelector.SingleItemSelectorContext<String,SelectorItem<String>>,List<org.jline.utils.AttributedString>> renderer)

Description copied from interface: SingleItemSelectorSpec

Sets a renderer function.

Specified by:

renderer in interface SingleItemSelectorSpec

Parameters:

renderer - the renderer

Returns:

a builder

template

public SingleItemSelectorSpec template(String location)

Description copied from interface: SingleItemSelectorSpec

Sets a default renderer template location.

Specified by:

template in interface SingleItemSelectorSpec

Parameters:

location - the template location

Returns:

a builder

max

public SingleItemSelectorSpec max(int max)

Description copied from interface: SingleItemSelectorSpec

Sets a maximum number of items in a selector list;

Specified by:

max in interface SingleItemSelectorSpec

Parameters:

max - the maximum number of items

Returns:

a builder

preHandler

public SingleItemSelectorSpec preHandler(Consumer<SingleItemSelector.SingleItemSelectorContext<String,SelectorItem<String>>> handler)

Description copied from interface: SingleItemSelectorSpec

Adds a pre-run context handler.

Specified by:

preHandler in interface SingleItemSelectorSpec

Parameters:

handler - the context handler

Returns:

a builder

postHandler

public SingleItemSelectorSpec postHandler(Consumer<SingleItemSelector.SingleItemSelectorContext<String,SelectorItem<String>>> handler)

Description copied from interface: SingleItemSelectorSpec

Adds a post-run context handler.

Specified by:

postHandler in interface SingleItemSelectorSpec

Parameters:

handler - the context handler

Returns:

a builder

storeResult

public SingleItemSelectorSpec storeResult(boolean store)

Description copied from interface: SingleItemSelectorSpec

Automatically stores result from a SingleItemSelector.SingleItemSelectorContext into ComponentContext with key given to builder. Defaults to true.

Specified by:

storeResult in interface SingleItemSelectorSpec

Parameters:

store - the flag if storing result

Returns:

a builder

next

public SingleItemSelectorSpec next(Function<SingleItemSelector.SingleItemSelectorContext<String,SelectorItem<String>>,String> next)

Description copied from interface: SingleItemSelectorSpec

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 SingleItemSelectorSpec

Parameters:

next - next component function

Returns:

a builder

and

public ComponentFlow.Builder and()

Description copied from interface: SingleItemSelectorSpec

Build and return parent builder.

Specified by:

and in interface SingleItemSelectorSpec

Returns:

the parent builder

getThis

public SingleItemSelectorSpec getThis()

Description copied from interface: BaseInputSpec

Usual this trick to get typed child.

Specified by:

getThis in interface BaseInputSpec<SingleItemSelectorSpec>

Returns:

a builder

getName

public String getName()

getResultValue

public String getResultValue()

getResultMode

public ResultMode getResultMode()

getSelectItems

public List<SelectItem> getSelectItems()

getDefaultSelect

public String getDefaultSelect()

getComparator

public Comparator<SelectorItem<String>> getComparator()

getRenderer

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

getTemplateLocation

public String getTemplateLocation()

getMaxItems

public Integer getMaxItems()

getPreHandlers

public List<Consumer<SingleItemSelector.SingleItemSelectorContext<String,SelectorItem<String>>>> getPreHandlers()

getPostHandlers

public List<Consumer<SingleItemSelector.SingleItemSelectorContext<String,SelectorItem<String>>>> getPostHandlers()

isStoreResult

public boolean isStoreResult()

getNext

public Function<SingleItemSelector.SingleItemSelectorContext<String,SelectorItem<String>>,String> getNext()