org.springframework.shell.component.support

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

java.lang.Object

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

org.springframework.shell.component.support.AbstractTextComponent<T,C>

All Implemented Interfaces:

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

Direct Known Subclasses:

ConfirmationInput, PathInput, StringInput

public abstract class AbstractTextComponent<T,C extends AbstractTextComponent.TextComponentContext<T,C>>
extends AbstractComponent<C>

Base class for components which work on a simple text input.

Author:

Janne Valkealahti

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractTextComponent.BaseTextComponentContext<T,C extends AbstractTextComponent.TextComponentContext<T,C>>
static interface	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
AbstractTextComponent(org.jline.terminal.Terminal terminal)
AbstractTextComponent(org.jline.terminal.Terminal terminal, String name)
AbstractTextComponent(org.jline.terminal.Terminal terminal, String name, Function<C,List<org.jline.utils.AttributedString>> renderer)

Method Summary

Modifier and Type	Method and Description
protected void	bindKeyMap(org.jline.keymap.KeyMap<String> keyMap) Bind key map.
protected String	getName() Gets a name.
protected C	runInternal(C context) Run internal logic called from public run method.

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

addPostRunHandler, addPreRunHandler, getTemplateExecutor, getTerminal, getThisContext, hasTty, loop, read, 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

AbstractTextComponent

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

AbstractTextComponent

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

AbstractTextComponent

public AbstractTextComponent(org.jline.terminal.Terminal terminal,
                             String name,
                             Function<C,List<org.jline.utils.AttributedString>> renderer)

Method Detail

bindKeyMap

protected void bindKeyMap(org.jline.keymap.KeyMap<String> keyMap)

Description copied from class: AbstractComponent

Bind key map.

Specified by:

bindKeyMap in class AbstractComponent<C extends AbstractTextComponent.TextComponentContext<T,C>>

runInternal

protected C runInternal(C context)

Description copied from class: AbstractComponent

Run internal logic called from public run method.

Specified by:

runInternal in class AbstractComponent<C extends AbstractTextComponent.TextComponentContext<T,C>>

Parameters:

context - the context

Returns:

a context

getName

protected String getName()

Gets a name.

Returns:

a name