BaseStringInput (Spring Shell Documentation 2.1.17 API)

java.lang.Object
- org.springframework.shell.component.flow.BaseInput<StringInputSpec>
- - org.springframework.shell.component.flow.BaseStringInput

All Implemented Interfaces:

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

Direct Known Subclasses:

DefaultStringInputSpec
```
public abstract class BaseStringInput
extends BaseInput<StringInputSpec>
implements StringInputSpec
```
Base impl for StringInputSpec.

Author:

Janne Valkealahti

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

Constructor Summary

Constructors
Constructor and Description

BaseStringInput(ComponentFlow.BaseBuilder builder, String id)

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

Class BaseStringInput

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

BaseStringInput

Method Detail

name

resultValue

resultMode

defaultValue

maskCharacter

renderer

template

preHandler

postHandler

storeResult

next

and

getThis

getName

getResultValue

getResultMode

getDefaultValue

getMaskCharacter

getRenderer

getTemplateLocation

getPreHandlers

getPostHandlers

isStoreResult

getNext