ks.protocol
Class ChatCommand

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

All Implemented Interfaces:

java.io.Serializable

public class ChatCommand

extends Command

Represents a command to send text to all players on a table.

See Also:

Serialized Form

Field Summary

static java.lang.String	tableNameArg
static java.lang.String	tableTypeArg

Constructor Summary

ChatCommand()
Default ChatManagerCommand constructor: used for others

ChatCommand(java.lang.String tableName, java.lang.String tableType, java.lang.String msg)
Default ChatManagerCommand constructor: used for chatting.

Method Summary

java.lang.String	getChatString() Get string to be chatted
java.lang.String	getTableName() Get string to be chatted.
java.lang.String	getTableType() Get table type.
java.lang.String	noSuchTable(java.lang.String tableName) No such table active in server.
void	setChatString(java.lang.String newString) Set chat String.
void	setTableName(java.lang.String newString) Set table name.
void	setTableType(java.lang.String newString) Set table type.

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

tableTypeArg

public static final java.lang.String tableTypeArg

See Also:

Constant Field Values

tableNameArg

public static final java.lang.String tableNameArg

See Also:

Constant Field Values

Constructor Detail

ChatCommand

public ChatCommand()

Default ChatManagerCommand constructor: used for others

ChatCommand

public ChatCommand(java.lang.String tableName,
                   java.lang.String tableType,
                   java.lang.String msg)

Default ChatManagerCommand constructor: used for chatting.

Parameters:

tableName - Destination table name.

tableType - Destination table type.

msg - Message to send.

Method Detail

getChatString

public java.lang.String getChatString()

Get string to be chatted

Returns:

String

setChatString

public void setChatString(java.lang.String newString)

Set chat String.

Parameters:

newString - String

getTableName

public java.lang.String getTableName()

Get string to be chatted.

Returns:

String

setTableName

public void setTableName(java.lang.String newString)

Set table name.

Parameters:

newString - String

getTableType

public java.lang.String getTableType()

Get table type.

Returns:

String

setTableType

public void setTableType(java.lang.String newString)

Set table type.

Parameters:

newString - String

noSuchTable

public java.lang.String noSuchTable(java.lang.String tableName)

No such table active in server.

Parameters:

tableName - Requested table name that wasn't found.

Returns:

Formatted Error String.