Package org.springframework.shell.jline
Class NonInteractiveShellRunner
java.lang.Object
org.springframework.shell.jline.NonInteractiveShellRunner
- All Implemented Interfaces:
ShellRunner
A
ShellRunner
that executes commands without entering interactive shell mode.
Has higher precedence than InteractiveShellRunner
which gives it an opportunity to handle the shell
in non-interactive fashion.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
The precedence at which this runner is ordered by the DefaultApplicationRunner - which also controls the order it is consulted on the ability to handle the current shell. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
canRun
(org.springframework.boot.ApplicationArguments args) Checks if a particular shell runner can execute.void
run
(org.springframework.boot.ApplicationArguments args) Execute application.void
setCommandsFromInputArgs
(Function<org.springframework.boot.ApplicationArguments, List<String>> commandsFromInputArgs) Sets the function that creates the command() to run from the input application arguments.void
setLineParser
(org.jline.reader.Parser lineParser) Sets the line parser used to parse commands.
-
Field Details
-
PRECEDENCE
public static final int PRECEDENCEThe precedence at which this runner is ordered by the DefaultApplicationRunner - which also controls the order it is consulted on the ability to handle the current shell.- See Also:
-
-
Constructor Details
-
NonInteractiveShellRunner
-
-
Method Details
-
setCommandsFromInputArgs
public void setCommandsFromInputArgs(Function<org.springframework.boot.ApplicationArguments, List<String>> commandsFromInputArgs) Sets the function that creates the command() to run from the input application arguments.- Parameters:
commandsFromInputArgs
- function that takes input application arguments and creates zero or more commands where each command is a string that specifies the command and options (eg. 'history --file myHistory.txt')
-
setLineParser
public void setLineParser(org.jline.reader.Parser lineParser) Sets the line parser used to parse commands.- Parameters:
lineParser
- the line parser used to parse commands
-
canRun
public boolean canRun(org.springframework.boot.ApplicationArguments args) Description copied from interface:ShellRunner
Checks if a particular shell runner can execute.- Specified by:
canRun
in interfaceShellRunner
- Parameters:
args
- the application arguments- Returns:
- true if shell runner can execute
-
run
Description copied from interface:ShellRunner
Execute application.- Specified by:
run
in interfaceShellRunner
- Parameters:
args
- the application argumets- Throws:
Exception
- in errors
-