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, Console console)
This method will be called as the starting point to execute the logic for the action mapped to this command.java.util.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, getCommandRegistry, getInterpreter, getOptions, getService, isServiceAvailable, printHelp, printQuickHelp, skipParsingAtNonOption, touchArguments
-
-
-
-
Constructor Detail
-
HelpCommand
public HelpCommand(CommandRegistry registry)
-
-
Method Detail
-
execute
public void execute(ParsedOptions options, Console console) throws java.lang.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 optionsconsole
- the console- Throws:
java.lang.Exception
- if an error occurs during command execution
-
getArgumentsList
public java.util.List<Arguments> getArgumentsList()
- Specified by:
getArgumentsList
in interfaceCommand
- Overrides:
getArgumentsList
in classAbstractCommand
-
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
-
-