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

Modifier and Type	Method and Description
default String[]	getAliases() Get the array of aliases for this command.
DictionaryArgument[]	getArguments() Get the array of DictionaryArgument for this DictionaryCommand.
Command.CommandCategory	getCategory() Get the CommandCategory for this DictionaryCommand.
String	getCommandName() Get the name of the DictionaryCommand.
default String	getDescription() Get the description for this DictionaryCommand.
int	getLevel() Get the level for this DictionaryCommand.
Duration	getTimeout() Returns the default timeout value associated with this command.
Command.CommandType	getType() Get the CommandType for this DictionaryCommand.
boolean	isAutoAck() Returns true if the ACK should be automatically sent by the framework before invoking this command.
boolean	isVarArgs() Determine if this DictionaryCommand has a variable number of arguments.
default boolean	matchesCommandOrAlias(String value) Test if value matches this command (either the command itself or one if its aliases).

Field Detail

NO_ALIASES

static final String[] NO_ALIASES

Method Detail

getCommandName

String getCommandName()

Get the name of the DictionaryCommand. A DictionaryCommand can also have aliases. See getAliases.

Returns:

The name of the Command.

getAliases

default String[] getAliases()

Get the array of aliases for this command. The DictionaryCommand can be referenced either via its name or one of its aliases (if present).

Returns:

The array of aliases. By default it returns an empty String array.

getArguments

DictionaryArgument[] getArguments()

Get the array of DictionaryArgument for this DictionaryCommand.

Returns:

The array of DictionaryArguments.

getDescription

default String getDescription()

Get the description for this DictionaryCommand.

Returns:

The DictionaryCommand description. By default it's the empty String.

getType

Command.CommandType getType()

Get the CommandType for this DictionaryCommand.

Returns:

The CommandType

isVarArgs

boolean isVarArgs()

Determine if this DictionaryCommand has a variable number of arguments.

Returns:

true if this DictionaryCommand has a variable number of arguments. false otherwise.

getLevel

int getLevel()

Get the level for this DictionaryCommand. The higher the level the more permissions are required to be able to invoke the command.

Returns:

The level of the DictionaryCommand.

matchesCommandOrAlias

default 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

getCategory

Command.CommandCategory getCategory()

Get the CommandCategory for this DictionaryCommand. The CommandCategory is used to determine the visibility of this command during tab completion or when the help command is invoked. By default DictionaryCommands with category USER are displayed.

Returns:

The DictionaryCommand CommandCategory

isAutoAck

boolean isAutoAck()

Returns true if the ACK should be automatically sent by the framework before invoking this command.

Returns:

true if the ACK should be automatically generated.

getTimeout

Duration getTimeout()

Returns the default timeout value associated with this command.

Returns:

The default timeout for this command, or null if there is no default.