ikrs.yuccasrv.commandline
Class CommandHelp

java.lang.Object
  ikrs.util.AbstractCommand
      ikrs.util.DefaultCommand
          ikrs.yuccasrv.commandline.YuccaCommand
              ikrs.yuccasrv.commandline.CommandHelp

All Implemented Interfaces:

Command, java.lang.Comparable<Command>

public class CommandHelp
extends YuccaCommand

This is the default HELP command implementation.

Constructor Summary

CommandHelp(YuccaCommandFactory factory, java.lang.String name, BasicType[] params)

Method Summary

int	execute() This is the final execution method - the default implementation has only one simple effect: if the command name equals "QUIT" or "EXIT" (not case sensitive) the method calls System.exit(0).

Methods inherited from class ikrs.yuccasrv.commandline.YuccaCommand

getFactory, setFactory, setName, setParams

Methods inherited from class ikrs.util.DefaultCommand

compareTo

Methods inherited from class ikrs.util.AbstractCommand

getName, getParamAt, getParamCount, toString, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface ikrs.util.Command

getName, getParamAt, getParamCount, toString

Constructor Detail

CommandHelp

public CommandHelp(YuccaCommandFactory factory,
                   java.lang.String name,
                   BasicType[] params)

Method Detail

execute

public int execute()

This is the final execution method - the default implementation has only one simple effect: if the command name equals "QUIT" or "EXIT" (not case sensitive) the method calls System.exit(0). Otherwise it returns always 1. Your subclasses should override this method. Note that this method does _not_ throw any exceptions! Its up to a stored internal command handler to handle exceptions.

Specified by:

execute in interface Command

Overrides:

execute in class YuccaCommand

Returns:

a return code that indicates the execution result. It depends on the context what the exact meaning of the return code is, but usually the value 0 (zero) implies success.