de.uniba.wiai.lspi.chord.console.command
Class Help

java.lang.Object
  extended by de.uniba.wiai.lspi.util.console.Command
      extended by de.uniba.wiai.lspi.chord.console.command.Help

public class Help
extends Command

This command prints a list of available commands. Just type help into the console.

Version:
1.0.5
Author:
sven

Field Summary
static java.lang.String COMMAND_NAME
          The name of this Command.
 
Constructor Summary
Help(java.lang.Object[] toCommand1, java.io.PrintStream out1)
          Creates a new instance of Help
 
Method Summary
 void exec()
          To be overwritten by subclasses for command execution.
 java.lang.String getCommandName()
          Return the name of the command.
 void printOutHelp()
          To be overwritten.
 
Methods inherited from class de.uniba.wiai.lspi.util.console.Command
addParameter, execute, setParameters, setPrintStream
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COMMAND_NAME

public static final java.lang.String COMMAND_NAME
The name of this Command.

See Also:
Constant Field Values
Constructor Detail

Help

public Help(java.lang.Object[] toCommand1,
            java.io.PrintStream out1)
Creates a new instance of Help

Parameters:
toCommand1 -
out1 -
Method Detail

exec

public void exec()
Description copied from class: Command
To be overwritten by subclasses for command execution. The work of a command implementation is done in this method.

Specified by:
exec in class Command

getCommandName

public java.lang.String getCommandName()
Description copied from class: Command
Return the name of the command. Must not contain spaces. To be overwritten by subclasses.

Specified by:
getCommandName in class Command
Returns:
The commands name. For example: exit.

printOutHelp

public void printOutHelp()
Description copied from class: Command
To be overwritten. Display the help text of the Command.

Specified by:
printOutHelp in class Command