Package org.springframework.shell.jline

Class NonInteractiveShellRunner

java.lang.Object

org.springframework.shell.jline.NonInteractiveShellRunner

All Implemented Interfaces:

ShellRunner

@Order(-50)
public class NonInteractiveShellRunner
extends Object
implements 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.

Author:

Janne Valkealahti, Chris Bono

Field Summary

Fields

Modifier and Type	Field	Description
static final int	PRECEDENCE	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

Constructors

Constructor	Description
NonInteractiveShellRunner(Shell shell, ShellContext shellContext)
NonInteractiveShellRunner(Shell shell, ShellContext shellContext, String primaryCommand)

Method Summary

Modifier and Type	Method	Description
boolean	run(String[] args)	Execute ShellRunner with given args.
void	setCommandsFromArgs(Function<String[],List<String>> commandsFromArgs)	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.

Methods inherited from class java.lang.Object

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

Field Details

PRECEDENCE

public static final int PRECEDENCE

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.

See Also:

• Constant Field Values

Constructor Details

NonInteractiveShellRunner

public NonInteractiveShellRunner(Shell shell,
 ShellContext shellContext)

NonInteractiveShellRunner

public NonInteractiveShellRunner(Shell shell,
 ShellContext shellContext,
 String primaryCommand)

Method Details

setCommandsFromArgs

public void setCommandsFromArgs(Function<String[],List<String>> commandsFromArgs)

Sets the function that creates the command() to run from the input application arguments.

Parameters:

commandsFromArgs - 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

run

public boolean run(String[] args)
            throws Exception

Description copied from interface: ShellRunner

Execute ShellRunner with given args. Return value indicates if run operation happened and no further runners should be used.

Specified by:

run in interface ShellRunner

Parameters:

args - the raw arguments

Returns:

true if run execution happened

Throws:

Exception - possible error during run