BaseConfirmationInput (Spring Shell Documentation 2.1.17 API)

java.lang.Object
- org.springframework.shell.component.flow.BaseInput<ConfirmationInputSpec>
- - org.springframework.shell.component.flow.BaseConfirmationInput

All Implemented Interfaces:

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

Direct Known Subclasses:

DefaultConfirmationInputSpec
```
public abstract class BaseConfirmationInput
extends BaseInput<ConfirmationInputSpec>
implements ConfirmationInputSpec
```
Base impl for ConfirmationInputSpec.

Author:

Janne Valkealahti

Field Summary
- Fields inherited from interface org.springframework.core.Ordered
  HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors
Constructor and Description

BaseConfirmationInput(ComponentFlow.BaseBuilder builder, String id)

Constructors
Constructor and Description
`BaseConfirmationInput(ComponentFlow.BaseBuilder builder, String id)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ComponentFlow.Builder`	`and()` Build and return parent builder.
`ConfirmationInputSpec`	`defaultValue(Boolean defaultValue)` Sets a default value.
`boolean`	`getDefaultValue()`
`String`	`getName()`
`Function<ConfirmationInput.ConfirmationInputContext,String>`	`getNext()`
`List<Consumer<ConfirmationInput.ConfirmationInputContext>>`	`getPostHandlers()`
`List<Consumer<ConfirmationInput.ConfirmationInputContext>>`	`getPreHandlers()`
`Function<ConfirmationInput.ConfirmationInputContext,List<org.jline.utils.AttributedString>>`	`getRenderer()`
`ResultMode`	`getResultMode()`
`Boolean`	`getResultValue()`
`String`	`getTemplateLocation()`
`ConfirmationInputSpec`	`getThis()` Usual this trick to get typed child.
`boolean`	`isStoreResult()`
`ConfirmationInputSpec`	`name(String name)` Sets a name.
`ConfirmationInputSpec`	`next(Function<ConfirmationInput.ConfirmationInputContext,String> next)` Define a function which may return id of a next component to go.
`ConfirmationInputSpec`	`postHandler(Consumer<ConfirmationInput.ConfirmationInputContext> handler)` Adds a post-run context handler.
`ConfirmationInputSpec`	`preHandler(Consumer<ConfirmationInput.ConfirmationInputContext> handler)` Adds a pre-run context handler.
`ConfirmationInputSpec`	`renderer(Function<ConfirmationInput.ConfirmationInputContext,List<org.jline.utils.AttributedString>> renderer)` Sets a renderer function.
`ConfirmationInputSpec`	`resultMode(ResultMode resultMode)` Sets a result mode.
`ConfirmationInputSpec`	`resultValue(Boolean resultValue)` Sets a result value.
`ConfirmationInputSpec`	`storeResult(boolean store)` Automatically stores result from a `ConfirmationInput.ConfirmationInputContext` into `ComponentContext` with key given to builder.
`ConfirmationInputSpec`	`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 Detail
  - BaseConfirmationInput
```
public BaseConfirmationInput(ComponentFlow.BaseBuilder builder,
                             String id)
```
- Method Detail
  - name
```
public ConfirmationInputSpec name(String name)
```
    Description copied from interface: ConfirmationInputSpec
    
    Sets a name.
    
    Specified by:
    
    name in interface ConfirmationInputSpec
    
    Parameters:
    
    name - the name
    
    Returns:
    
    a builder
  - resultValue
```
public ConfirmationInputSpec resultValue(Boolean resultValue)
```
    Description copied from interface: ConfirmationInputSpec
    
    Sets a result value.
    
    Specified by:
    
    resultValue in interface ConfirmationInputSpec
    
    Parameters:
    
    resultValue - the result value
    
    Returns:
    
    a builder
  - resultMode
```
public ConfirmationInputSpec resultMode(ResultMode resultMode)
```
    Description copied from interface: ConfirmationInputSpec
    
    Sets a result mode.
    
    Specified by:
    
    resultMode in interface ConfirmationInputSpec
    
    Parameters:
    
    resultMode - the result mode
    
    Returns:
    
    a builder
  - defaultValue
```
public ConfirmationInputSpec defaultValue(Boolean defaultValue)
```
    Description copied from interface: ConfirmationInputSpec
    
    Sets a default value.
    
    Specified by:
    
    defaultValue in interface ConfirmationInputSpec
    
    Parameters:
    
    defaultValue - the defult value
    
    Returns:
    
    a builder
  - renderer
```
public ConfirmationInputSpec renderer(Function<ConfirmationInput.ConfirmationInputContext,List<org.jline.utils.AttributedString>> renderer)
```
    Description copied from interface: ConfirmationInputSpec
    
    Sets a renderer function.
    
    Specified by:
    
    renderer in interface ConfirmationInputSpec
    
    Parameters:
    
    renderer - the renderer
    
    Returns:
    
    a builder
  - template
```
public ConfirmationInputSpec template(String location)
```
    Description copied from interface: ConfirmationInputSpec
    
    Sets a default renderer template location.
    
    Specified by:
    
    template in interface ConfirmationInputSpec
    
    Parameters:
    
    location - the template location
    
    Returns:
    
    a builder
  - preHandler
```
public ConfirmationInputSpec preHandler(Consumer<ConfirmationInput.ConfirmationInputContext> handler)
```
    Description copied from interface: ConfirmationInputSpec
    
    Adds a pre-run context handler.
    
    Specified by:
    
    preHandler in interface ConfirmationInputSpec
    
    Parameters:
    
    handler - the context handler
    
    Returns:
    
    a builder
  - postHandler
```
public ConfirmationInputSpec postHandler(Consumer<ConfirmationInput.ConfirmationInputContext> handler)
```
    Description copied from interface: ConfirmationInputSpec
    
    Adds a post-run context handler.
    
    Specified by:
    
    postHandler in interface ConfirmationInputSpec
    
    Parameters:
    
    handler - the context handler
    
    Returns:
    
    a builder
  - storeResult
```
public ConfirmationInputSpec storeResult(boolean store)
```
    Description copied from interface: ConfirmationInputSpec
    
    Automatically stores result from a ConfirmationInput.ConfirmationInputContext into ComponentContext with key given to builder. Defaults to true.
    
    Specified by:
    
    storeResult in interface ConfirmationInputSpec
    
    Parameters:
    
    store - the flag if storing result
    
    Returns:
    
    a builder
  - next
```
public ConfirmationInputSpec next(Function<ConfirmationInput.ConfirmationInputContext,String> next)
```
    Description copied from interface: ConfirmationInputSpec
    
    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 ConfirmationInputSpec
    
    Parameters:
    
    next - next component function
    
    Returns:
    
    a builder
  - and
```
public ComponentFlow.Builder and()
```
    Description copied from interface: ConfirmationInputSpec
    
    Build and return parent builder.
    
    Specified by:
    
    and in interface ConfirmationInputSpec
    
    Returns:
    
    the parent builder
  - getThis
```
public ConfirmationInputSpec getThis()
```
    Description copied from interface: BaseInputSpec
    
    Usual this trick to get typed child.
    
    Specified by:
    
    getThis in interface BaseInputSpec<ConfirmationInputSpec>
    
    Returns:
    
    a builder
  - getName
```
public String getName()
```
  - getDefaultValue
```
public boolean getDefaultValue()
```
  - getResultValue
```
public Boolean getResultValue()
```
  - getResultMode
```
public ResultMode getResultMode()
```
  - getRenderer
```
public Function<ConfirmationInput.ConfirmationInputContext,List<org.jline.utils.AttributedString>> getRenderer()
```
  - getTemplateLocation
```
public String getTemplateLocation()
```
  - getPreHandlers
```
public List<Consumer<ConfirmationInput.ConfirmationInputContext>> getPreHandlers()
```
  - getPostHandlers
```
public List<Consumer<ConfirmationInput.ConfirmationInputContext>> getPostHandlers()
```
  - isStoreResult
```
public boolean isStoreResult()
```
  - getNext
```
public Function<ConfirmationInput.ConfirmationInputContext,String> getNext()
```

Class BaseConfirmationInput

Field Summary

Fields inherited from interface org.springframework.core.Ordered

Constructor Summary

Method Summary

Methods inherited from class org.springframework.shell.component.flow.BaseInput

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseConfirmationInput

Method Detail

name

resultValue

resultMode

defaultValue

renderer

template

preHandler

postHandler

storeResult

next

and

getThis

getName

getDefaultValue

getResultValue

getResultMode

getRenderer

getTemplateLocation

getPreHandlers

getPostHandlers

isStoreResult

getNext