ks.common.message
Class Message

java.lang.Object
  ks.common.ArgumentList
      ks.common.message.Message

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

BulkLoginMessage, ClientMessage, LoginMessage, LogoutMessage, OutputMessage, PlugInManagerMessage, QuitMessage, UserManagerMessage

public abstract class Message

extends ArgumentList

implements java.io.Serializable

Messages are sent from the server to a client in response to a Command.

Each message has the following attributes:

• Scope - the intended scope of the message. On the client side, the client will change its processing of the message based upon this information.
• User - the user from which the message originates (not (always the same as the current client).
• TargetUser - the user for which this message is intended.

See Also:

Serialized Form

Constructor Summary

Message(java.lang.String toFromUser)
Create a message within the Protocol.globalScope scope to the given user from the given user.

Method Summary

java.lang.String	getFromUser() Return the user for this message.
java.lang.String	getScope() Return the scope for this message.
java.lang.String	getTargetUser() Return the user to whom this message is intended.
java.lang.String	getUser() Return the user for this message.
void	setFromUser(java.lang.String newUser) Change the user from whom this message is being sent.
void	setScope(java.lang.String newScope) Change the scope of this message.
void	setTargetUser(java.lang.String newUser) Change the user to whom this message is intended.
java.lang.String	toString() Present readable format for command.

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

Message

public Message(java.lang.String toFromUser)

Create a message within the Protocol.globalScope scope to the given user from the given user.

This is the most commonly used Message constructor.

Parameters:

toFromUser - String

Method Detail

getFromUser

public java.lang.String getFromUser()

Return the user for this message.

Returns:

String

getScope

public java.lang.String getScope()

Return the scope for this message.

Returns:

String

getTargetUser

public java.lang.String getTargetUser()

Return the user to whom this message is intended.

Returns:

String

getUser

public java.lang.String getUser()

Return the user for this message.

Returns:

String

setFromUser

public void setFromUser(java.lang.String newUser)

Change the user from whom this message is being sent.

Parameters:

newUser - String

setScope

public void setScope(java.lang.String newScope)

Change the scope of this message.

Parameters:

newScope - String

setTargetUser

public void setTargetUser(java.lang.String newUser)

Change the user to whom this message is intended.

Parameters:

newUser - String

toString

public java.lang.String toString()

Present readable format for command.

Overrides:

toString in class ArgumentList