Package com.aspectran.shell.command.builtin

Class HelpCommand

java.lang.Object

com.aspectran.shell.command.AbstractCommand

com.aspectran.shell.command.builtin.HelpCommand

All Implemented Interfaces:

Command

public class HelpCommand
extends AbstractCommand

Nested Class Summary

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

Command.Descriptor

Field Summary

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

options

Constructor Summary

Constructors

Constructor	Description
HelpCommand(CommandRegistry registry)

Method Summary

Modifier and Type	Method	Description
java.lang.String	execute(java.lang.String[] args)	This method will be called as the starting point to execute the logic for the action mapped to this command.
Command.Descriptor	getDescriptor()	This method returns an instance of Command.Descriptor.

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

addOption, getCommandRegistry, getConsole, getService, parse, printUsage, printUsage

Methods inherited from class java.lang.Object

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

Constructor Detail

HelpCommand

public HelpCommand(CommandRegistry registry)

Method Detail

execute

public java.lang.String execute(java.lang.String[] args)
                         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:

args - the command line arguments

Returns:

the message output to the console as a result of an executed command

Throws:

java.lang.Exception - if an error occurs during command execution

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