Package org.springframework.shell.core.autoconfigure

Class JLineShellAutoConfiguration

java.lang.Object

org.springframework.shell.core.autoconfigure.JLineShellAutoConfiguration

@AutoConfiguration
@EnableConfigurationProperties(SpringShellProperties.class)
@ConditionalOnClass(org.jline.reader.History.class)
@ImportAutoConfiguration(classes={ThemingAutoConfiguration.class,TerminalUIAutoConfiguration.class,ComponentFlowAutoConfiguration.class})
public class JLineShellAutoConfiguration
extends Object

Shell implementation using JLine to capture input and trigger completions.

Author:

Eric Bottard, Florent Biville, Mahmoud Ben Hassine, Piotr Olaszewski

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JLineShellAutoConfiguration.JLineHistoryConfiguration

Constructor Summary

Constructors

Constructor	Description
JLineShellAutoConfiguration(org.jline.reader.History jLineHistory, SpringShellProperties springShellProperties, UserConfigPathProvider userConfigPathProvider)

Method Summary

Modifier and Type	Method	Description
CommandCompleter	commandCompleter(CommandRegistry commandRegistry)
CommandHighlighter	commandHighlighter(CommandRegistry commandRegistry)
Command	historyCommand(org.jline.reader.History jLineHistory)
JLineInputProvider	inputProvider(org.jline.reader.LineReader lineReader, PromptProvider promptProvider)
ShellRunner	jlineShellRunner(JLineInputProvider inputProvider, CommandParser commandParser, CommandRegistry commandRegistry, org.springframework.core.env.Environment environment)
org.jline.reader.LineReader	lineReader(org.jline.terminal.Terminal terminal, org.jline.reader.Parser parser, CommandCompleter commandCompleter, CommandHighlighter commandHighlighter)
void	onContextClosedEvent(org.springframework.context.event.ContextClosedEvent event)
org.jline.reader.Parser	parser()
PromptProvider	promptProvider()
org.jline.terminal.Terminal	terminal(org.springframework.beans.factory.ObjectProvider<TerminalCustomizer> customizers)

Methods inherited from class java.lang.Object

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

Constructor Details

JLineShellAutoConfiguration

public JLineShellAutoConfiguration(org.jline.reader.History jLineHistory,
 SpringShellProperties springShellProperties,
 UserConfigPathProvider userConfigPathProvider)

Method Details

onContextClosedEvent

@EventListener
public void onContextClosedEvent(org.springframework.context.event.ContextClosedEvent event)
                          throws IOException

Throws:

IOException

jlineShellRunner

@Bean
@ConditionalOnProperty(prefix="spring.shell.interactive",
                       name="enabled",
                       havingValue="true",
                       matchIfMissing=true)
public ShellRunner jlineShellRunner(JLineInputProvider inputProvider,
 CommandParser commandParser,
 CommandRegistry commandRegistry,
 org.springframework.core.env.Environment environment)

lineReader

@Bean
public org.jline.reader.LineReader lineReader(org.jline.terminal.Terminal terminal,
 org.jline.reader.Parser parser,
 CommandCompleter commandCompleter,
 CommandHighlighter commandHighlighter)

inputProvider

@Bean
public JLineInputProvider inputProvider(org.jline.reader.LineReader lineReader,
 PromptProvider promptProvider)

terminal

@Bean(destroyMethod="close")
public org.jline.terminal.Terminal terminal(org.springframework.beans.factory.ObjectProvider<TerminalCustomizer> customizers)

promptProvider

@Bean
@ConditionalOnMissingBean(PromptProvider.class)
public PromptProvider promptProvider()

parser

@Bean
public org.jline.reader.Parser parser()

commandHighlighter

@Bean
@ConditionalOnMissingBean
public CommandHighlighter commandHighlighter(CommandRegistry commandRegistry)

commandCompleter

@Bean
@ConditionalOnMissingBean
public CommandCompleter commandCompleter(CommandRegistry commandRegistry)

historyCommand

@Bean
@ConditionalOnProperty(value="spring.shell.command.history.enabled",
                       havingValue="true",
                       matchIfMissing=true)
public Command historyCommand(org.jline.reader.History jLineHistory)