org.springframework.boot.cli

Class SpringCli

java.lang.Object

org.springframework.boot.cli.SpringCli

public class SpringCli
extends Object

Spring Command Line Interface. This is the main entry-point for the Spring command line application. This class will parse input arguments and delegate to a suitable Command implementation based on the first argument.

The '-d' and '--debug' switches are handled by this class, however, most argument parsing is left to the Command implementation.

Author:

Phillip Webb

See Also:

main(String...), SpringCliException, Command

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLI_APP

Constructor Summary

Constructors

Constructor and Description
SpringCli() Create a new SpringCli implementation with the default set of commands.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	errorMessage(String message)
static void	main(String... args) The main CLI entry-point.
protected void	printStackTrace(Exception ex)
protected void	run(String... args) Parse the arguments and run a suitable command.
int	runAndHandleErrors(String... args) Run the CLI and handle and errors.
void	setCommands(List<? extends Command> commands) Set the command available to the CLI.
protected void	showUsage()

Methods inherited from class java.lang.Object

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

Field Detail

CLI_APP

public static final String CLI_APP

See Also:

Constant Field Values

Constructor Detail

SpringCli

public SpringCli()

Create a new SpringCli implementation with the default set of commands.

Method Detail

setCommands

public void setCommands(List<? extends Command> commands)

Set the command available to the CLI. Primarily used to support testing. NOTE: The 'help' command will be automatically provided in addition to this list.

Parameters:

commands - the commands to add

runAndHandleErrors

public int runAndHandleErrors(String... args)

Run the CLI and handle and errors.

Parameters:

args - the input arguments

Returns:

a return status code (non boot is used to indicate an error)

run

protected void run(String... args)
            throws Exception

Parse the arguments and run a suitable command.

Parameters:

args - the arguments

Throws:

Exception

showUsage

protected void showUsage()

errorMessage

protected void errorMessage(String message)

printStackTrace

protected void printStackTrace(Exception ex)

main

public static void main(String... args)

The main CLI entry-point.

Parameters:

args - CLI arguments