Class ServerResponse

java.lang.Object

ServerResponse

public final class ServerResponse
extends Object

Represents responses sent from the server to the client in response to a client Command, a user registration, or a user deregistration. A ServerResponse consists of a base Command in the same form as those sent from the client to server, along with an additional sender which indicates the sender whose action generated the response.

There are generally two use cases for this class: first, for responses that involve relaying a client Command back to the sender, and possibly also to other clients; and second, for responses like ERROR that are generated by the server. See the protocol specification for more details.

You should not edit this file.

Constructor Summary

Constructors

Constructor and Description
ServerResponse(String sender, Command.Type commandType, String payload) A convenience constructor which builds a new Command without parameters from its (other) components to create the ServerResponse.
ServerResponse(String sender, Command.Type commandType, String p0, String p1, String payload) A convenience constructor which builds a new Command from its components to create the ServerResponse.
ServerResponse(String sender, Command command) Constructs a ServerResponse from a base Command and the sender.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
Command	getCommand()
String	getSender()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ServerResponse

public ServerResponse(String sender,
              Command command)

Constructs a ServerResponse from a base Command and the sender.

Parameters:

sender - the sender whose action generated this response

command - the base command

Throws:

IllegalArgumentException - if sender or command is null

ServerResponse

public ServerResponse(String sender,
              Command.Type commandType,
              String p0,
              String p1,
              String payload)

A convenience constructor which builds a new Command from its components to create the ServerResponse.

Parameters:

sender - the sender whose action generated this response

commandType - the command type

p0 - the first parameter, or null if absent

p1 - the second parameter, or null if absent

payload - the payload, or null if absent

Throws:

IllegalArgumentException - if sender is null, or if the command is syntactically invalid; see Command for details

See Also:

Command.Command(Command.Type, String, String, String)

ServerResponse

public ServerResponse(String sender,
              Command.Type commandType,
              String payload)

A convenience constructor which builds a new Command without parameters from its (other) components to create the ServerResponse.

Parameters:

sender - the sender whose action generated this response

commandType - the command type

payload - the payload, or null if absent

Throws:

IllegalArgumentException - if sender is null, or if the command is syntactically invalid; see Command for details

See Also:

Command.Command(Command.Type, String)

Method Detail

getSender

public String getSender()

Returns:

the sender

getCommand

public Command getCommand()

Returns:

the base command

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object