ks.common.command
Class Command

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

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

ChatCommand, CreateCommand, ErrorCommand, FingerCommand, GameOverCommand, HelpCommand, JoinCommand, LeaveTableCommand, LogoutCommand, OutputCommand, PlugInManagerCommand, ProtocolCommand, QuitCommand, RejoinCommand, ShoutCommand, TableManagerCommand, TablesCommand, TellCommand, UserManagerCommand, WhoCommand

public class Command

extends ArgumentList

implements java.io.Serializable

Root class for all Command objects sent from the client and the server.

There are several attributes associated with a Command.

• type -- The type of the command.
• quittable -- Is the client attempting to exit?
• error -- Was there a problem in parsing the arguments when the Command was parsed?

See Also:

Serialized Form

Method Summary

static java.lang.String	formatString(java.lang.String s) Insert backslash before 'quote' characters.
boolean	isError() Determine if parsing the command was in error.
boolean	isQuittable() Determine if execution of command causes client to quit.
void	setQuittable(boolean newQuittable) Set determination of quittable.
java.lang.String	toString() Present readable format for command.

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

Method Detail

formatString

public static java.lang.String formatString(java.lang.String s)

Insert backslash before 'quote' characters.

Note sure how much of this is necessary. Make sure that starting and terminating quotes are untouched.

Parameters:

s - the value

Returns:

String the modified value

isError

public boolean isError()

Determine if parsing the command was in error.

Returns:

boolean

isQuittable

public boolean isQuittable()

Determine if execution of command causes client to quit.

Returns:

boolean

setQuittable

public void setQuittable(boolean newQuittable)

Set determination of quittable.

Parameters:

newQuittable - boolean

toString

public java.lang.String toString()

Present readable format for command.

Overrides:

toString in class ArgumentList