Package com.aspectran.shell.command.builtins

Class HelpCommand

java.lang.Object

com.aspectran.shell.command.AbstractCommand

com.aspectran.shell.command.builtins.HelpCommand

All Implemented Interfaces:

Command

public class HelpCommand
extends AbstractCommand

Display information about builtin commands.

Nested Class Summary

Nested classes/interfaces inherited from interface com.aspectran.shell.command.Command

Command.Descriptor

Constructor Summary

Constructors

Constructor	Description
HelpCommand(CommandRegistry registry)

Method Summary

Modifier and Type	Method	Description
void	execute(ParsedOptions options, ShellConsole console)	This method will be called as the starting point to execute the logic for the action mapped to this command.
List<Arguments>	getArgumentsList()
Command.Descriptor	getDescriptor()	This method returns an instance of Command.Descriptor.

Methods inherited from class com.aspectran.shell.command.AbstractCommand

addArguments, addOption, getActiveShellService, getCommandRegistry, getCommandRunner, getOptions, getShellService, isServiceAvailable, printHelp, printQuickHelp, skipParsingAtNonOption, touchArguments

Methods inherited from class java.lang.Object

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

Constructor Details

HelpCommand

public HelpCommand(CommandRegistry registry)

Method Details

execute

public void execute(@NonNull
 ParsedOptions options,
 ShellConsole console)
             throws Exception

Description copied from interface: Command

This method will be called as the starting point to execute the logic for the action mapped to this command.

Parameters:

options - the parsed options

console - the console

Throws:

Exception - if an error occurs during command execution

getArgumentsList

public List<Arguments> getArgumentsList()

Specified by:

getArgumentsList in interface Command

Overrides:

getArgumentsList in class AbstractCommand

getDescriptor

public Command.Descriptor getDescriptor()

Description copied from interface: Command

This method returns an instance of Command.Descriptor. The descriptor is meta information about the command.

Returns:

a Descriptor that is meta information about the command