Package org.springframework.shell.jline.tui.component

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.jline.tui.component.support.AbstractTextComponent.TextComponentContext

AbstractTextComponent.TextComponentContext.MessageLevel

Method Summary

Modifier and Type	Method	Description
static StringInput.StringInputContext	empty()	Gets an empty StringInput.StringInputContext.
@Nullable String	getDefaultValue()	Gets a default value.
@Nullable Character	getMaskCharacter()	Gets a mask character.
@Nullable String	getMaskedInput()	Gets a masked input.
@Nullable String	getMaskedResultValue()	Gets a masked result value.
boolean	hasMaskCharacter()	Returns flag if there is a mask character defined.
boolean	isRequired()	Returns flag if input is required.
static StringInput.StringInputContext	of(@Nullable String defaultValue, @Nullable Character maskCharacter)	Gets an StringInput.StringInputContext.
static StringInput.StringInputContext	of(@Nullable String defaultValue, @Nullable Character maskCharacter, boolean required)	Gets an StringInput.StringInputContext.
void	setDefaultValue(@Nullable String defaultValue)	Sets a default value.
void	setMaskCharacter(Character maskCharacter)	Sets a mask character.
void	setRequired(boolean required)	Sets flag for mandatory input.

Methods inherited from interface org.springframework.shell.jline.tui.component.support.AbstractTextComponent.TextComponentContext

getInput, getMessage, getMessageLevel, getName, getResultValue, setInput, setMessage, setMessage, setMessageLevel, setName, setResultValue

Methods inherited from interface org.springframework.shell.jline.tui.component.context.ComponentContext

containsKey, get, get, getTerminalWidth, put, setTerminalWidth, stream, toTemplateModel

Method Details

getDefaultValue

@Nullable String getDefaultValue()

Gets a default value.

Returns:

a default value

setDefaultValue

void setDefaultValue(@Nullable String defaultValue)

Sets a default value.

Parameters:

defaultValue - the default value

setMaskCharacter

void setMaskCharacter(Character maskCharacter)

Sets a mask character.

Parameters:

maskCharacter - the mask character

getMaskedInput

@Nullable String getMaskedInput()

Gets a masked input.

Returns:

a masked input

getMaskedResultValue

@Nullable 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

@Nullable Character getMaskCharacter()

Gets a mask character.

Returns:

a mask character.

setRequired

void setRequired(boolean required)

Sets flag for mandatory input.

Parameters:

required - true if input is required

isRequired

boolean isRequired()

Returns flag if input is required.

Returns:

true if input is required, false otherwise

empty

static StringInput.StringInputContext empty()

Gets an empty StringInput.StringInputContext.

Returns:

empty path input context

of

static StringInput.StringInputContext of(@Nullable String defaultValue,
 @Nullable Character maskCharacter)

Gets an StringInput.StringInputContext.

Returns:

path input context

of

static StringInput.StringInputContext of(@Nullable String defaultValue,
 @Nullable Character maskCharacter,
 boolean required)

Gets an StringInput.StringInputContext.

Returns:

path input context