ks.protocol
Class TellCommand

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

All Implemented Interfaces:

java.io.Serializable

public class TellCommand

extends Command

Represents the command for sending a private message to another user in the main lobby. singleArg userName multiArg textName

See Also:

Serialized Form

Field Summary

static java.lang.String	noUserSpecified No user specified error message.
static java.lang.String	textName the message.
static java.lang.String	userName The name of the user getting message.

Constructor Summary

TellCommand()
Default TellCommand constructor.

Method Summary

java.lang.String	getMessage() Return string concatenation of shout arguments.
java.lang.String	getUser() Return user
java.lang.String	noSuchUser(java.lang.String user) Generate Error String when user not currently logged in.
java.lang.String	outputFormat(java.lang.String fromUser, java.lang.String msg) Format string message about tell.
void	setMessage(java.lang.String msg) Set message
void	setUser(java.lang.String user) Set target user.
java.lang.String	userNotLoggedIn(java.lang.String user) Generate Error String when user not currently logged in.

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

userName

public static final java.lang.String userName

The name of the user getting message.

See Also:

Constant Field Values

textName

public static final java.lang.String textName

the message.

See Also:

Constant Field Values

noUserSpecified

public static final java.lang.String noUserSpecified

No user specified error message.

See Also:

Constant Field Values

Constructor Detail

TellCommand

public TellCommand()

Default TellCommand constructor.

Method Detail

getMessage

public java.lang.String getMessage()

Return string concatenation of shout arguments.

setUser

public void setUser(java.lang.String user)

Set target user.

Parameters:

user - String

setMessage

public void setMessage(java.lang.String msg)

Set message

Parameters:

msg - String

getUser

public java.lang.String getUser()

Return user

Returns:

String

userNotLoggedIn

public java.lang.String userNotLoggedIn(java.lang.String user)

Generate Error String when user not currently logged in.

Parameters:

user - the target User

noSuchUser

public java.lang.String noSuchUser(java.lang.String user)

Generate Error String when user not currently logged in.

Parameters:

user - the target User

outputFormat

public java.lang.String outputFormat(java.lang.String fromUser,
                                     java.lang.String msg)

Format string message about tell.