org.lsst.ccs.command

Class DictionaryCommand

java.lang.Object

org.lsst.ccs.command.DictionaryCommand

All Implemented Interfaces:

Serializable

public class DictionaryCommand
extends Object
implements Serializable

Encapsulate the dictionary information for a single command and parameters. This class is serializable for use in client-server applications, so does not maintain any references to Class or Method objects which may not be available in a remote client.

Author:

turri

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
String[]	getAliases()
String	getCommandName()
String	getDescription()
DictionaryParameter[]	getParams()
Command.CommandType	getType()
boolean	isVarArgs()
boolean	matchesCommandOrAlias(String value) Test if value matches this command (either the command itself or one if its aliases).

Methods inherited from class java.lang.Object

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

Method Detail

getDescription

public String getDescription()

getAliases

public String[] getAliases()

getParams

public DictionaryParameter[] getParams()

getType

public Command.CommandType getType()

getCommandName

public String getCommandName()

isVarArgs

public boolean isVarArgs()

matchesCommandOrAlias

public boolean matchesCommandOrAlias(String value)

Test if value matches this command (either the command itself or one if its aliases).

Parameters:

value - The value to test

Returns:

true if the value matches