org.mockftpserver.core.command

Class Command

java.lang.Object

org.mockftpserver.core.command.Command

public final class Command
extends java.lang.Object

Represents a command received from an FTP client, containing a command name and parameters. Objects of this class are immutable.

Constructor Summary

Constructors

Constructor and Description
Command(java.lang.String name, java.util.List parameters) Construct a new immutable instance with the specified command name and parameters
Command(java.lang.String name, java.lang.String[] parameters) Construct a new immutable instance with the specified command name and parameters

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getName()
java.lang.String	getOptionalString(int index) Get the String value of the parameter at the specified index; return null if no parameter exists for the index.
java.lang.String	getParameter(int index) Get the String value of the parameter at the specified index; return null if no parameter exists for the index
java.lang.String[]	getParameters()
java.lang.String	getRequiredParameter(int index) Get the String value of the parameter at the specified index
int	hashCode()
static java.lang.String	normalizeName(java.lang.String name) Return the name, normalized to a common format - convert to upper case.
java.lang.String	toString() Return the String representation of this object

Methods inherited from class java.lang.Object

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

Constructor Detail

Command

public Command(java.lang.String name,
               java.lang.String[] parameters)

Construct a new immutable instance with the specified command name and parameters

Parameters:

name - - the command name; may not be null

parameters - - the command parameters; may be empty; may not be null

Command

public Command(java.lang.String name,
               java.util.List parameters)

Construct a new immutable instance with the specified command name and parameters

Parameters:

name - - the command name; may not be null

parameters - - the command parameters; may be empty; may not be null

Method Detail

getName

public java.lang.String getName()

Returns:

the name

getParameters

public java.lang.String[] getParameters()

Returns:

the parameters

getRequiredParameter

public java.lang.String getRequiredParameter(int index)

Get the String value of the parameter at the specified index

Parameters:

index - - the index

Returns:

the parameter value as a String

Throws:

AssertFailedException - if the parameter index is invalid or the value is not a valid String

getParameter

public java.lang.String getParameter(int index)

Get the String value of the parameter at the specified index; return null if no parameter exists for the index

Parameters:

index - - the index

Returns:

the parameter value as a String, or null if this Command does not have a parameter for that index

getOptionalString

public java.lang.String getOptionalString(int index)

Get the String value of the parameter at the specified index; return null if no parameter exists for the index. This is an alias for getParameter(int).

Parameters:

index - - the index

Returns:

the parameter value as a String, or null if this Command does not have a parameter for that index

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

See Also:

Object.equals(java.lang.Object)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

See Also:

Object.hashCode()

toString

public java.lang.String toString()

Return the String representation of this object

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()

normalizeName

public static java.lang.String normalizeName(java.lang.String name)

Return the name, normalized to a common format - convert to upper case.

Parameters:

name - - the command name

Returns:

the name converted to upper case