org.adougou.cline
Class HelpCommand

java.lang.Object
  |
  +--org.adougou.cline.BaseCommand
        |
        +--org.adougou.cline.HelpCommand

All Implemented Interfaces:

Command

public class HelpCommand

extends BaseCommand

This command is used to query information about any command that has been registered with the prompt.

Fields inherited from class org.adougou.cline.BaseCommand

help_, name_, numArgs_, prompt, register_

Method Summary

void	execute(java.lang.String[] args) This method should be overloaded by each command that is defined - it will be called by the CommandRegister after the number of arguments have been checked.
java.lang.String	getHelp() This method overloads the BaseCommand help function - the HelpCommand is the only class where this makes sense.

Methods inherited from class org.adougou.cline.BaseCommand

checkPermission, execute, execute, getName, getPrompt, set

Methods inherited from class java.lang.Object

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

Method Detail

execute

public void execute(java.lang.String[] args)

Description copied from class: BaseCommand

This method should be overloaded by each command that is defined - it will be called by the CommandRegister after the number of arguments have been checked.

Overrides:

execute in class BaseCommand

getHelp

public java.lang.String getHelp()

This method overloads the BaseCommand help function - the HelpCommand is the only class where this makes sense.

Overrides:

getHelp in class BaseCommand