org.lsst.ccs.command

Interface DictionaryCommand

All Superinterfaces:

Serializable

public interface DictionaryCommand
extends 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:

tonyj

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	NO_ALIASES

Method Summary

Methods

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

Field Detail

NO_ALIASES

static final String[] NO_ALIASES

Method Detail

getAliases

String[] getAliases()

getArguments

DictionaryArgument[] getArguments()

getCommandName

String getCommandName()

getDescription

String getDescription()

getType

Command.CommandType getType()

isVarArgs

boolean isVarArgs()

getLevel

int getLevel()

matchesCommandOrAlias

boolean matchesCommandOrAlias(String value)

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

Parameters:

value - The value to test

Returns:

true if the value matches