SingleItemSelectorSpec (Spring Shell Documentation 2.1.17 API)

All Superinterfaces:

BaseInputSpec<SingleItemSelectorSpec>

All Known Implementing Classes:

BaseSingleItemSelector, DefaultSingleInputSpec
```
public interface SingleItemSelectorSpec
extends BaseInputSpec<SingleItemSelectorSpec>
```
Interface for single item selector spec builder.

Author:

Janne Valkealahti

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`ComponentFlow.Builder`	`and()` Build and return parent builder.
`SingleItemSelectorSpec`	`defaultSelect(String name)` Automatically selects and exposes a given item.
`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(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 interface org.springframework.shell.component.flow.BaseInputSpec
getThis, order

- Method Detail
  - name
```
SingleItemSelectorSpec name(String name)
```
    Sets a name.
    
    Parameters:
    
    name - the name
    
    Returns:
    
    a builder
  - resultValue
```
SingleItemSelectorSpec resultValue(String resultValue)
```
    Sets a result value.
    
    Parameters:
    
    resultValue - the result value
    
    Returns:
    
    a builder
  - resultMode
```
SingleItemSelectorSpec resultMode(ResultMode resultMode)
```
    Sets a result mode.
    
    Parameters:
    
    resultMode - the result mode
    
    Returns:
    
    a builder
  - selectItem
```
SingleItemSelectorSpec selectItem(String name,
                                  String item)
```
    Adds a select item.
    
    Parameters:
    
    name - the name
    
    item - the item
    
    Returns:
    
    a builder
  - selectItems
```
SingleItemSelectorSpec selectItems(Map<String,String> selectItems)
```
    Adds a map of select items.
    
    Parameters:
    
    selectItems - the select items
    
    Returns:
    
    a builder
  - defaultSelect
```
SingleItemSelectorSpec defaultSelect(String name)
```
    Automatically selects and exposes a given item.
    
    Parameters:
    
    name - the name
    
    Returns:
    
    a builder
  - sort
```
SingleItemSelectorSpec sort(Comparator<SelectorItem<String>> comparator)
```
    Sets a Comparator for sorting items.
    
    Parameters:
    
    comparator - the item comparator
    
    Returns:
    
    a builder
  - renderer
```
SingleItemSelectorSpec renderer(Function<SingleItemSelector.SingleItemSelectorContext<String,SelectorItem<String>>,List<org.jline.utils.AttributedString>> renderer)
```
    Sets a renderer function.
    
    Parameters:
    
    renderer - the renderer
    
    Returns:
    
    a builder
  - template
```
SingleItemSelectorSpec template(String location)
```
    Sets a default renderer template location.
    
    Parameters:
    
    location - the template location
    
    Returns:
    
    a builder
  - max
```
SingleItemSelectorSpec max(int max)
```
    Sets a maximum number of items in a selector list;
    
    Parameters:
    
    max - the maximum number of items
    
    Returns:
    
    a builder
  - preHandler
```
SingleItemSelectorSpec preHandler(Consumer<SingleItemSelector.SingleItemSelectorContext<String,SelectorItem<String>>> handler)
```
    Adds a pre-run context handler.
    
    Parameters:
    
    handler - the context handler
    
    Returns:
    
    a builder
  - postHandler
```
SingleItemSelectorSpec postHandler(Consumer<SingleItemSelector.SingleItemSelectorContext<String,SelectorItem<String>>> handler)
```
    Adds a post-run context handler.
    
    Parameters:
    
    handler - the context handler
    
    Returns:
    
    a builder
  - storeResult
```
SingleItemSelectorSpec storeResult(boolean store)
```
    Automatically stores result from a SingleItemSelector.SingleItemSelectorContext into ComponentContext with key given to builder. Defaults to true.
    
    Parameters:
    
    store - the flag if storing result
    
    Returns:
    
    a builder
  - next
```
SingleItemSelectorSpec next(Function<SingleItemSelector.SingleItemSelectorContext<String,SelectorItem<String>>,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

Interface SingleItemSelectorSpec

Method Summary

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

Method Detail

name

resultValue

resultMode

selectItem

selectItems

defaultSelect

sort

renderer

template

max

preHandler

postHandler

storeResult

next

and