org.springframework.boot.cli

Interface Command

All Known Implementing Classes:

AbstractCommand, CleanCommand, CreateCommand, OptionParsingCommand, RunCommand, ScriptCommand, VersionCommand

public interface Command

A single command that can be run from the CLI.

Author:

Phillip Webb, Dave Syer

See Also:

run(String...)

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription() Returns a description of the command.
String	getHelp() Gets full help text for the command, e.g.
String	getName() Returns the name of the command.
String	getUsageHelp() Returns usage help for the command.
void	run(String... args) Run the command.

Method Detail

getName

String getName()

Returns the name of the command.

getDescription

String getDescription()

Returns a description of the command.

getUsageHelp

String getUsageHelp()

Returns usage help for the command. This should be a simple one-line string describing basic usage. e.g. '[options] <file>'. Do not include the name of the command in this string.

getHelp

String getHelp()

Gets full help text for the command, e.g. a longer description and one line per option.

run

void run(String... args)
         throws Exception

Run the command.

Parameters:

args - command arguments (this will not include the command itself)

Throws:

Exception