Package org.springframework.boot.cli.command.core

Class HelpCommand

java.lang.Object

org.springframework.boot.cli.command.AbstractCommand

org.springframework.boot.cli.command.core.HelpCommand

All Implemented Interfaces:

Command

public class HelpCommand
extends AbstractCommand

Internal Command used for 'help' requests.

Since:

1.0.0

Author:

Phillip Webb

Constructor Summary

Constructors

Constructor	Description
HelpCommand(CommandRunner commandRunner)

Method Summary

Modifier and Type	Method	Description
String	getHelp()	Gets full help text for the command, e.g.
Collection<OptionHelp>	getOptionsHelp()	Returns help for each supported option.
String	getUsageHelp()	Returns usage help for the command.
ExitStatus	run(String... args)	Run the command.

Methods inherited from class org.springframework.boot.cli.command.AbstractCommand

getDescription, getExamples, getName

Methods inherited from class java.lang.Object

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

Constructor Details

HelpCommand

public HelpCommand(CommandRunner commandRunner)

Method Details

getUsageHelp

public String getUsageHelp()

Description copied from interface: Command

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.

Specified by:

getUsageHelp in interface Command

Overrides:

getUsageHelp in class AbstractCommand

Returns:

the command's usage help

getHelp

public String getHelp()

Description copied from interface: Command

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

Specified by:

getHelp in interface Command

Overrides:

getHelp in class AbstractCommand

Returns:

the command's help text

getOptionsHelp

public Collection<OptionHelp> getOptionsHelp()

Description copied from interface: Command

Returns help for each supported option.

Specified by:

getOptionsHelp in interface Command

Overrides:

getOptionsHelp in class AbstractCommand

Returns:

help for each of the command's options

run

public ExitStatus run(String... args)
               throws Exception

Description copied from interface: Command

Run the command.

Parameters:

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

Returns:

the outcome of the command

Throws:

Exception - if the command fails