Package org.springframework.shell.core.command

Class Help

java.lang.Object

org.springframework.shell.core.command.AbstractCommand

org.springframework.shell.core.command.Help

All Implemented Interfaces:

Command

public class Help
extends AbstractCommand

A command to display help about all available commands.

Author:

Eric Bottard, Janne Valkealahti, Piotr Olaszewski, Mahmoud Ben Hassine

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.shell.core.command.Command

Command.Builder

Constructor Summary

Constructors

Constructor	Description
Help()

Method Summary

Modifier and Type	Method	Description
ExitStatus	doExecute(CommandContext commandContext)
String	getHelp()	Get the help text of the command.

Methods inherited from class org.springframework.shell.core.command.AbstractCommand

equals, execute, getAliases, getAvailabilityProvider, getCompletionProvider, getDescription, getExitStatusExceptionMapper, getGroup, getName, getOptions, hashCode, isHelp, isHidden, println, setAliases, setAvailabilityProvider, setCompletionProvider, setExitStatusExceptionMapper, setOptions

Methods inherited from class java.lang.Object

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

Constructor Details

Help

public Help()

Method Details

getHelp

public String getHelp()

Description copied from interface: Command

Get the help text of the command.

Specified by:

getHelp in interface Command

Overrides:

getHelp in class AbstractCommand

Returns:

the help text of the command

doExecute

public ExitStatus doExecute(CommandContext commandContext)
                     throws Exception

Specified by:

doExecute in class AbstractCommand

Throws:

Exception