ks.protocol
Class LeaveTableCommand

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

All Implemented Interfaces:

java.io.Serializable

public class LeaveTableCommand

extends Command

Class representing the command to leave a table.

Creation date: (10/21/01 10:26:36 PM)

See Also:

Serialized Form

Constructor Summary

LeaveTableCommand()
Default constructor for Leave Table Commands

Method Summary

static java.lang.String	errorFailedLeave(java.lang.String tableName) Generate error message to show when leave command fails for some reason.
static java.lang.String	errorLeave(java.lang.String tableName) Generate error message to show when attempting to leave a table of which user is not a member.
static java.lang.String	errorNoSuchTable(java.lang.String tableName) Generate error message to show when attempting to leave a table that does not exist.
java.lang.String	getTableName() Return name of table.
java.lang.String	getTableType() Return type of table.
void	setTableName(java.lang.String newTableName) Set table name.
void	setTableType(java.lang.String newTableType) Set table type.
static java.lang.String	successfulLeave(java.lang.String tableName) Generate message to show when leaving a table.
static java.lang.String	tableClosed(java.lang.String tableName) Generate message to show when table is closing.

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

LeaveTableCommand

public LeaveTableCommand()

Default constructor for Leave Table Commands

Method Detail

setTableName

public void setTableName(java.lang.String newTableName)

Set table name.

Parameters:

newTableName - String

setTableType

public void setTableType(java.lang.String newTableType)

Set table type.

Parameters:

newTableType - 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

successfulLeave

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

Generate message to show when leaving a table.

Parameters:

tableName - representing table whose attempt to leave is allowed.

errorLeave

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

Generate error message to show when attempting to leave a table of which user is not a member.

Parameters:

tableName - representing table whose attempt to leave is denied.

errorFailedLeave

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

Generate error message to show when leave command fails for some reason.

Parameters:

tableName - representing table whose attempt to leave is denied.

errorNoSuchTable

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

Generate error message to show when attempting to leave a table that does not exist.

Parameters:

tableName - representing table whose attempt to leave is denied.

tableClosed

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

Generate message to show when table is closing.

Parameters:

tableName - representing table that is now closed.