Package org.springframework.shell.component

Class PathSearch

java.lang.Object

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

org.springframework.shell.component.support.AbstractTextComponent<Path,PathSearch.PathSearchContext>

org.springframework.shell.component.PathSearch

All Implemented Interfaces:

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

public class PathSearch
extends AbstractTextComponent<Path,PathSearch.PathSearchContext>

Component resolving Path based on base path and optional search term. User is expected to type a base path and then delimited by space and a search term. Based on algorithms i.e. from https://github.com/junegunn/fzf and other sources.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PathSearch.PathScannerResult	Result from a path scanning.
static class	PathSearch.PathSearchConfig	Class defining configuration for path search.
static interface	PathSearch.PathSearchContext	Context for PathSearch.
static class	PathSearch.ScoredPath	Holder class keeping Path and SearchMatchResult.

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	Description
PathSearch(org.jline.terminal.Terminal terminal)
PathSearch(org.jline.terminal.Terminal terminal, String name)
PathSearch(org.jline.terminal.Terminal terminal, String name, PathSearch.PathSearchConfig config)
PathSearch(org.jline.terminal.Terminal terminal, String name, PathSearch.PathSearchConfig config, Function<PathSearch.PathSearchContext,List<org.jline.utils.AttributedString>> renderer)

Method Summary

Modifier and Type	Method	Description
protected void	bindKeyMap(org.jline.keymap.KeyMap<String> keyMap)	Bind key map.
PathSearch.PathSearchContext	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, PathSearch.PathSearchContext 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

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 Details

PathSearch

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

PathSearch

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

PathSearch

public PathSearch(org.jline.terminal.Terminal terminal,
 String name,
 PathSearch.PathSearchConfig config)

PathSearch

public PathSearch(org.jline.terminal.Terminal terminal,
 String name,
 PathSearch.PathSearchConfig config,
 Function<PathSearch.PathSearchContext,List<org.jline.utils.AttributedString>> renderer)

Method Details

bindKeyMap

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

Description copied from class: AbstractComponent

Bind key map.

Overrides:

bindKeyMap in class AbstractTextComponent<Path,PathSearch.PathSearchContext>

getThisContext

public PathSearch.PathSearchContext getThisContext(ComponentContext<?> context)

Description copied from class: AbstractComponent

Gets a real component context using common this trick.

Specified by:

getThisContext in class AbstractComponent<PathSearch.PathSearchContext>

Parameters:

context - the context

Returns:

a component context

read

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

Description copied from class: AbstractComponent

Read input.

Specified by:

read in class AbstractComponent<PathSearch.PathSearchContext>

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