Package org.springframework.shell.boot

Class JLineShellAutoConfiguration

java.lang.Object

org.springframework.shell.boot.JLineShellAutoConfiguration

@AutoConfiguration
@EnableConfigurationProperties(SpringShellProperties.class)
public class JLineShellAutoConfiguration
extends Object

Shell implementation using JLine to capture input and trigger completions.

Author:

Eric Bottard, Florent Biville, Mahmoud Ben Hassine

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
JLineInputProvider	inputProvider(org.jline.reader.LineReader lineReader)
org.jline.reader.LineReader	lineReader(org.jline.terminal.Terminal terminal, org.jline.reader.Parser parser, CommandRegistry commandRegistry)
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

lineReader

@Bean
public org.jline.reader.LineReader lineReader(org.jline.terminal.Terminal terminal,
 org.jline.reader.Parser parser,
 CommandRegistry commandRegistry)

inputProvider

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

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()