ks.protocol
Class JoinCommand

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

All Implemented Interfaces:

java.io.Serializable

public class JoinCommand

extends Command

Class to represent the command to join a table.

See Also:

Serialized Form

Field Summary

static java.lang.String

tableReady Table is ready to go message.

Constructor Summary

JoinCommand()
Default Constructor.

Method Summary

static java.lang.String	errorAlreadyMember(java.lang.String tableName) Generate error when attempting to join table on which user already is a member.
static java.lang.String	errorJoin(java.lang.String tableName) Generate error when attempting to join table for some reason.
java.lang.String	getTableName() Return name of table.
java.lang.String	getTableType() Return type of table.
static java.lang.String	noSuchTable(java.lang.String tableName) Generate error when attempting to join non-existent table.
void	setTableName(java.lang.String newTableName) Set table name.
void	setTableType(java.lang.String newTableType) Set table type.
static java.lang.String	successfulJoin(java.lang.String tableName, int num, int maxPlayers) Generate error when attempting to join table on which user already is a member.
static java.lang.String	waitingFor(java.lang.String tableName, int num) Generate error when attempting to join table on which user already is a member.

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

tableReady

public static final java.lang.String tableReady

Table is ready to go message.

See Also:

Constant Field Values

Constructor Detail

JoinCommand

public JoinCommand()

Default Constructor.

Method Detail

setTableName

public void setTableName(java.lang.String newTableName)

Set table name.

Parameters:

newTableName - java.lang.String

setTableType

public void setTableType(java.lang.String newTableType)

Set table type.

Parameters:

newTableType - java.lang.String

getTableName

public java.lang.String getTableName()

Return name of table.

Returns:

java.lang.String

getTableType

public java.lang.String getTableType()

Return type of table.

Returns:

java.lang.String

noSuchTable

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

Generate error when attempting to join non-existent table.

Parameters:

tableName - representing table whose attempt to join is denied.

errorAlreadyMember

public static final java.lang.String errorAlreadyMember(java.lang.String tableName)

Generate error when attempting to join table on which user already is a member.

Parameters:

tableName - representing table whose attempt to join is denied.

successfulJoin

public static final java.lang.String successfulJoin(java.lang.String tableName,
                                                    int num,
                                                    int maxPlayers)

Generate error when attempting to join table on which user already is a member.

Parameters:

tableName - representing table whose attempt to join is allowed.

waitingFor

public static final java.lang.String waitingFor(java.lang.String tableName,
                                                int num)

Generate error when attempting to join table on which user already is a member.

Parameters:

tableName - name of table which has yet to be filled.

num - number of participants to join.

errorJoin

public static final java.lang.String errorJoin(java.lang.String tableName)

Generate error when attempting to join table for some reason.

Parameters:

tableName - representing table whose attempt to join is denied.