Interface StringInput.StringInputContext
- All Superinterfaces:
AbstractTextComponent.TextComponentContext<String,
,StringInput.StringInputContext> ComponentContext<StringInput.StringInputContext>
- Enclosing class:
- StringInput
public static interface StringInput.StringInputContext
extends AbstractTextComponent.TextComponentContext<String,StringInput.StringInputContext>
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.springframework.shell.component.support.AbstractTextComponent.TextComponentContext
AbstractTextComponent.TextComponentContext.MessageLevel
-
Method Summary
Modifier and TypeMethodDescriptionempty()
Gets an emptyStringInput.StringInputContext
.Gets a default value.Gets a mask character.Gets a masked input.Gets a masked result value.boolean
Returns flag if there is a mask character defined.Gets anStringInput.StringInputContext
.void
setDefaultValue
(String defaultValue) Sets a default value.void
setMaskCharacter
(Character maskCharacter) Sets a mask character.Methods inherited from interface org.springframework.shell.component.support.AbstractTextComponent.TextComponentContext
getInput, getMessage, getMessageLevel, getName, getResultValue, setInput, setMessage, setMessage, setMessageLevel, setName, setResultValue
Methods inherited from interface org.springframework.shell.component.context.ComponentContext
containsKey, get, get, getTerminalWidth, put, setTerminalWidth, stream, toTemplateModel
-
Method Details
-
getDefaultValue
String getDefaultValue()Gets a default value.- Returns:
- a default value
-
setDefaultValue
Sets a default value.- Parameters:
defaultValue
- the default value
-
setMaskCharacter
Sets a mask character.- Parameters:
maskCharacter
- the mask character
-
getMaskedInput
String getMaskedInput()Gets a masked input.- Returns:
- a masked input
-
getMaskedResultValue
String getMaskedResultValue()Gets a masked result value.- Returns:
- masked result value
-
hasMaskCharacter
boolean hasMaskCharacter()Returns flag if there is a mask character defined.- Returns:
- true if mask character defined, false otherwise
-
getMaskCharacter
Character getMaskCharacter()Gets a mask character.- Returns:
- a mask character.
-
empty
Gets an emptyStringInput.StringInputContext
.- Returns:
- empty path input context
-
of
Gets anStringInput.StringInputContext
.- Returns:
- path input context
-