public interface DictionaryCommand extends Serializable
| Modifier and Type | Field and Description |
|---|---|
static String[] |
NO_ALIASES |
| 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.
|
Command.CommandType |
getType()
Get the
CommandType for this DictionaryCommand. |
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).
|
static final String[] NO_ALIASES
String getCommandName()
getAliases.default String[] getAliases()
DictionaryArgument[] getArguments()
DictionaryArgument for this DictionaryCommand.default String getDescription()
Command.CommandType getType()
CommandType for this DictionaryCommand.boolean isVarArgs()
int getLevel()
default boolean matchesCommandOrAlias(String value)
value - The value to testtrue if the value matchesCommand.CommandCategory getCategory()
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.CommandCategoryCopyright © 2015 LSST. All rights reserved.