org.springframework.shell.component

Class PathInput

java.lang.Object

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

org.springframework.shell.component.support.AbstractTextComponent<Path,PathInput.PathInputContext>

org.springframework.shell.component.PathInput

All Implemented Interfaces:

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

public class PathInput
extends AbstractTextComponent<Path,PathInput.PathInputContext>

Component for a simple path input.

Author:

Janne Valkealahti

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PathInput.PathInputContext

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
PathInput(org.jline.terminal.Terminal terminal)
PathInput(org.jline.terminal.Terminal terminal, String name)
PathInput(org.jline.terminal.Terminal terminal, String name, Function<PathInput.PathInputContext,List<org.jline.utils.AttributedString>> renderer)

Method Summary

Modifier and Type	Method and Description
PathInput.PathInputContext	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, PathInput.PathInputContext context) Read input.
protected Path	resolvePath(String path) Resolves a Path from a given raw path.
void	setPathProvider(Function<String,Path> pathProvider) Sets a path provider.

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

PathInput

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

PathInput

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

PathInput

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

Method Detail

getThisContext

public PathInput.PathInputContext getThisContext(ComponentContext<?> context)

Description copied from class: AbstractComponent

Gets a real component context using common this trick.

Specified by:

getThisContext in class AbstractComponent<PathInput.PathInputContext>

Parameters:

context - the context

Returns:

a component context

read

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

Description copied from class: AbstractComponent

Read input.

Specified by:

read in class AbstractComponent<PathInput.PathInputContext>

Parameters:

bindingReader - the binding reader

keyMap - the key map

context - the context

Returns:

true if read is complete, false to stop

setPathProvider

public void setPathProvider(Function<String,Path> pathProvider)

Sets a path provider.

Parameters:

pathProvider - the path provider

resolvePath

protected Path resolvePath(String path)

Resolves a Path from a given raw path.

Parameters:

path - the raw path

Returns:

a resolved path