Class Command

java.lang.Object

Command

public abstract class Command
extends Object

Represents a command string sent from a client to the server, after it has been parsed into a more convenient form. The Command abstract class has a concrete subclass corresponding to each of the possible commands that can be issued by a client. The protocol specification contains more information about the expected behavior of various commands.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	sender
protected int	senderId

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Command(int senderId, String sender)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Returns true if two Commands are equal; that is, they produce the same string representation.
String	getSender() Returns the nickname of the client who issued the Command.
int	getSenderId() Returns the user ID of the client who issued the Command.
abstract Broadcast	updateServerModel(ServerModel model) Processes the command and updates the server model accordingly.

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

senderId

protected int senderId

sender

protected String sender

Constructor Detail

Command

protected Command(int senderId,
                  String sender)

Method Detail

getSenderId

public int getSenderId()

Returns the user ID of the client who issued the Command.

Returns:

a int which is the current user ID of the client

getSender

public String getSender()

Returns the nickname of the client who issued the Command.

Returns:

a non-null string which is the current nickname of the client

updateServerModel

public abstract Broadcast updateServerModel(ServerModel model)

Processes the command and updates the server model accordingly.

Parameters:

model - An instance of the ServerModelApi class which represents the current state of the server.

Returns:

A Broadcast object, informing clients about changes resulting from the command.

equals

public boolean equals(Object o)

Returns true if two Commands are equal; that is, they produce the same string representation.

Overrides:

equals in class Object

Parameters:

o - the object to compare with this for equality

Returns:

true iff both objects are non-null and equal to each other