org.springframework.shell.component

Class ConfirmationInput

java.lang.Object

org.springframework.shell.component.support.AbstractComponent<C>

org.springframework.shell.component.support.AbstractTextComponent<Boolean,ConfirmationInput.ConfirmationInputContext>

org.springframework.shell.component.ConfirmationInput

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.context.ResourceLoaderAware

public class ConfirmationInput
extends AbstractTextComponent<Boolean,ConfirmationInput.ConfirmationInputContext>

Component for a confirmation question.

Author:

Janne Valkealahti

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ConfirmationInput.ConfirmationInputContext

Nested classes/interfaces inherited from class org.springframework.shell.component.support.AbstractTextComponent

AbstractTextComponent.BaseTextComponentContext<T,C extends AbstractTextComponent.TextComponentContext<T,C>>, AbstractTextComponent.TextComponentContext<T,C extends AbstractTextComponent.TextComponentContext<T,C>>

Field Summary

Fields inherited from class org.springframework.shell.component.support.AbstractComponent

OPERATION_BACKSPACE, OPERATION_CHAR, OPERATION_DOWN, OPERATION_EXIT, OPERATION_SELECT, OPERATION_UP

Constructor Summary

Constructors

Constructor and Description
ConfirmationInput(org.jline.terminal.Terminal terminal)
ConfirmationInput(org.jline.terminal.Terminal terminal, String name)
ConfirmationInput(org.jline.terminal.Terminal terminal, String name, boolean defaultValue)
ConfirmationInput(org.jline.terminal.Terminal terminal, String name, boolean defaultValue, Function<ConfirmationInput.ConfirmationInputContext,List<org.jline.utils.AttributedString>> renderer)

Method Summary

Modifier and Type	Method and Description
ConfirmationInput.ConfirmationInputContext	getThisContext(ComponentContext<?> context) Gets a real component context using common this trick.
protected boolean	read(org.jline.keymap.BindingReader bindingReader, org.jline.keymap.KeyMap<String> keyMap, ConfirmationInput.ConfirmationInputContext context) Read input.

Methods inherited from class org.springframework.shell.component.support.AbstractTextComponent

bindKeyMap, getName, runInternal

Methods inherited from class org.springframework.shell.component.support.AbstractComponent

addPostRunHandler, addPreRunHandler, getTemplateExecutor, getTerminal, hasTty, loop, render, renderTemplateResource, run, runPostRunHandlers, runPreRunHandlers, setPrintResults, setRenderer, setResourceLoader, setTemplateExecutor, setTemplateLocation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConfirmationInput

public ConfirmationInput(org.jline.terminal.Terminal terminal)

ConfirmationInput

public ConfirmationInput(org.jline.terminal.Terminal terminal,
                         String name)

ConfirmationInput

public ConfirmationInput(org.jline.terminal.Terminal terminal,
                         String name,
                         boolean defaultValue)

ConfirmationInput

public ConfirmationInput(org.jline.terminal.Terminal terminal,
                         String name,
                         boolean defaultValue,
                         Function<ConfirmationInput.ConfirmationInputContext,List<org.jline.utils.AttributedString>> renderer)

Method Detail

getThisContext

public ConfirmationInput.ConfirmationInputContext getThisContext(ComponentContext<?> context)

Description copied from class: AbstractComponent

Gets a real component context using common this trick.

Specified by:

getThisContext in class AbstractComponent<ConfirmationInput.ConfirmationInputContext>

Parameters:

context - the context

Returns:

a component context

read

protected boolean read(org.jline.keymap.BindingReader bindingReader,
                       org.jline.keymap.KeyMap<String> keyMap,
                       ConfirmationInput.ConfirmationInputContext context)

Description copied from class: AbstractComponent

Read input.

Specified by:

read in class AbstractComponent<ConfirmationInput.ConfirmationInputContext>

Parameters:

bindingReader - the binding reader

keyMap - the key map

context - the context

Returns:

true if read is complete, false to stop