Class Command

java.lang.Object

Command

public final class Command
extends Object

Represents a command string sent from a client to the server, after being parsed into a more convenient data structure. It includes fields for the three parts of these commands, the type, the two parameters (which may or may not be present), and the payload (which also may not be present). See the protocol specification for more details about the command format.

You should not edit this file.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Command.Type This enumeration defines the various types of commands that the clients and server operate with.

Constructor Summary

Constructors

Constructor and Description
Command(Command.Type type, String payload) Convenience constructor for Commands with no parameters.
Command(Command.Type type, String param0, String param1, String payload) Constructs a Command with the provided components.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getParameter(int index) Returns the specified parameter.
int	getParameterCount() Counts the number of parameters in this command.
String	getPayload() Returns the payload.
Command.Type	getType() Returns the command type.
int	hashCode()
String	toString() Returns the representation of the Command as it would be sent over the wire to the server.

Methods inherited from class java.lang.Object

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

Constructor Detail

Command

public Command(Command.Type type,
       String param0,
       String param1,
       String payload)

Constructs a Command with the provided components. The parameter count and the presence or absence of a payload must agree with the command type according to the specification.

Parameters:

type - the command type

param0 - the first parameter, or null if absent

param1 - the second parameter, or null if absent

payload - the payload, or null if absent

Throws:

IllegalArgumentException - if type is null, or if the command is syntactically invalid; it has an incorrect parameter count, it is missing a payload where one is required, or it has a payload where one is invalid

Command

public Command(Command.Type type,
       String payload)

Convenience constructor for Commands with no parameters.

Parameters:

type - the command type

payload - the payload, or null if absent

See Also:

Command(Type, String, String, String)

Method Detail

getType

public Command.Type getType()

Returns the command type.

Returns:

the command type

getParameter

public String getParameter(int index)

Returns the specified parameter.

Parameters:

index - the 0-based index of the parameter to retrieve

Returns:

the parameter at the specified index

Throws:

IllegalArgumentException - if index is invalid

getParameterCount

public int getParameterCount()

Counts the number of parameters in this command.

Returns:

the parameter count

getPayload

public String getPayload()

Returns the payload.

Returns:

the payload, or null if there is none

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Returns the representation of the Command as it would be sent over the wire to the server.

Overrides:

toString in class Object

Returns:

the network representation of the command