ks.common.command
Class HelpCommand

java.lang.Object
  ks.common.ArgumentList
      ks.common.command.Command
          ks.common.command.HelpCommand

All Implemented Interfaces:

java.io.Serializable

public class HelpCommand

extends Command

Represents the command for telling user the list of all commands.

See Also:

Serialized Form

Field Summary

static java.lang.String

queryArg Query Argument.

Constructor Summary

HelpCommand()

Method Summary

java.lang.String	getQuery()
java.lang.String	helpString() Fixed string to return as help message
java.lang.String	respondToQuery() Specialized help for each command.
void	setQuery(java.lang.String s) set query string for individual command-by-command help.

Methods inherited from class ks.common.command.Command

formatString, isError, isQuittable, setQuittable, toString

Methods inherited from class ks.common.ArgumentList

addArgMulti, addArgMulti, addArgMulti, addArgMulti, addArgMulti, addArgMulti, addArgMulti, addArgMulti, clearArg, clearArg, clearArgMulti, clearArgMulti, getArg, getArg, getArgMulti, getArgMulti, multiArgs, removeArgMulti, removeArgMulti, removeArgMulti, removeArgMulti, removeArgMulti, removeArgMulti, removeArgMulti, removeArgMulti, setArg, setArg, singleArgs

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

queryArg

public static final java.lang.String queryArg

Query Argument.

See Also:

Constant Field Values

Constructor Detail

HelpCommand

public HelpCommand()

Method Detail

getQuery

public java.lang.String getQuery()

helpString

public java.lang.String helpString()

Fixed string to return as help message

respondToQuery

public java.lang.String respondToQuery()

Specialized help for each command.

Returns:

java.lang.String

setQuery

public void setQuery(java.lang.String s)

set query string for individual command-by-command help.

Parameters:

s - contents of help.