org.springframework.shell.jline

Class JLineShellAutoConfiguration

java.lang.Object

org.springframework.shell.jline.JLineShellAutoConfiguration

@Configuration
public class JLineShellAutoConfiguration
extends Object

Shell implementation using JLine to capture input and trigger completions.

Author:

Eric Bottard, Florent Biville

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JLineShellAutoConfiguration.CompleterAdapter A bridge between JLine's Completer contract and our own.
static class	JLineShellAutoConfiguration.HistoryConfiguration Installs a default JLine history, and triggers saving to file on context shutdown.

Constructor Summary

Constructors

Constructor and Description
JLineShellAutoConfiguration()

Method Summary

Modifier and Type	Method and Description
JLineShellAutoConfiguration.CompleterAdapter	completer()
org.springframework.boot.ApplicationRunner	interactiveApplicationRunner(org.jline.reader.Parser parser, org.springframework.core.env.Environment environment)
void	lateInit()
org.jline.reader.LineReader	lineReader()
org.jline.reader.Parser	parser()
PromptProvider	promptProvider()
org.springframework.boot.ApplicationRunner	scriptApplicationRunner(org.jline.reader.Parser parser, org.springframework.core.env.ConfigurableEnvironment environment)
org.jline.terminal.Terminal	terminal()

Methods inherited from class java.lang.Object

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

Constructor Detail

JLineShellAutoConfiguration

public JLineShellAutoConfiguration()

Method Detail

terminal

@Bean(destroyMethod="close")
public org.jline.terminal.Terminal terminal()

interactiveApplicationRunner

@Bean
 @ConditionalOnProperty(prefix="spring.shell.interactive",
                       value="enabled",
                       havingValue="true",
                       matchIfMissing=true)
public org.springframework.boot.ApplicationRunner interactiveApplicationRunner(org.jline.reader.Parser parser,
                                                                                                                                                                                                                                                                               org.springframework.core.env.Environment environment)

scriptApplicationRunner

@Bean
 @ConditionalOnProperty(prefix="spring.shell.script",
                       value="spring.shell.script",
                       havingValue="true",
                       matchIfMissing=true)
public org.springframework.boot.ApplicationRunner scriptApplicationRunner(org.jline.reader.Parser parser,
                                                                                                                                                                                                                                                                                 org.springframework.core.env.ConfigurableEnvironment environment)

promptProvider

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

completer

@Bean
public JLineShellAutoConfiguration.CompleterAdapter completer()

lateInit

@PostConstruct
public void lateInit()

parser

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

lineReader

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