ks.protocol
Class CreateCommand

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

All Implemented Interfaces:

java.io.Serializable

public class CreateCommand

extends Command

Class to represent the command to create a table.

See Also:

Serialized Form

Constructor Summary

CreateCommand()
Default CreateCommand Constructor.

Method Summary

static java.lang.String	failureCreate(java.lang.String tableName, java.lang.String reason) Error generated when a failure occurs when creating the table.
java.lang.String	getAccessType() Return access type of table.
int	getGameIncrement() Return Game Increment (of seed)
int	getGameLength() Return length of game in seconds
int	getNumPlayers() Return number of players for game.
int	getSeed() Return seed for game.
java.lang.String	getTableName() Return name of table.
java.lang.String	getTableType() Return type of table.
void	setAccessType(java.lang.String accType) Set the access type for this table.
void	setGameIncrement(int newGameIncrement) Set the game increment.
void	setGameLength(int newGameLength) Set Game Length.
void	setNumPlayers(int newNumPlayers) Set the number of players for desired game.
void	setSeed(int newSeed) Set seed value for this create game request.
void	setTableName(java.lang.String newTableName) Set table name.
void	setTableType(java.lang.String newTableType) Set table type.
static java.lang.String	tableAlreadyExists(java.lang.String tableName) Error generated when table already exists

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

Constructor Detail

CreateCommand

public CreateCommand()

Default CreateCommand Constructor.

Method Detail

failureCreate

public static final java.lang.String failureCreate(java.lang.String tableName,
                                                   java.lang.String reason)

Error generated when a failure occurs when creating the table.

getAccessType

public java.lang.String getAccessType()

Return access type of table.

Returns:

java.lang.String

Since:

V2.2.1

getGameIncrement

public int getGameIncrement()

Return Game Increment (of seed)

Returns:

int

getGameLength

public int getGameLength()

Return length of game in seconds

Returns:

int

getNumPlayers

public int getNumPlayers()

Return number of players for game.

Returns:

int

getSeed

public int getSeed()

Return seed for game.

Returns:

int

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

setAccessType

public void setAccessType(java.lang.String accType)

Set the access type for this table.

Parameters:

accType - String

Since:

V2.2.1

setGameIncrement

public void setGameIncrement(int newGameIncrement)

Set the game increment.

Parameters:

newGameIncrement - int

setGameLength

public void setGameLength(int newGameLength)

Set Game Length.

Parameters:

newGameLength - int

setNumPlayers

public void setNumPlayers(int newNumPlayers)

Set the number of players for desired game.

Parameters:

newNumPlayers - int

setSeed

public void setSeed(int newSeed)

Set seed value for this create game request.

Parameters:

newSeed - int

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

tableAlreadyExists

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

Error generated when table already exists