Package org.lsst.ccs.command

An experimental package for testing possible improvements to the command handling mechanism built-in to the CCS core.

See: Description

Interface Summary

Interface	Description
BasicCommand	A interface implemented by both TokenizedCommand and RawCommand
CommandSet	A CommandSet is a combination of a Dictionary plus the ability to invoke a command.
Dictionary	A command dictionary contains all the information needed to provide help and perform tab completion.
DictionaryArgument	Encapsulate the dictionary information about a single argument.
DictionaryCommand	Encapsulate the dictionary information for a single command and parameters.
LocalCommandDictionary	interface to define a "Local" Command Dictionary on a per-class basis.

Class Summary

Class	Description
CommandDictionaryBuilder	This class consists of a CommandDictionary plus a map of which methods should be called as a result of each command.
CommandSetBuilder	Takes a single object and builds a command set from its annotated methods.
CompositeCommandDictionary	A command dictionary to which other command dictionaries can be added and removed.
CompositeCommandSet	A class which can combine multiple command sets to form one combined command set.
DictionariesTree	Client codes can receive a complete Tree of DictionaryContext from a Subsystem.
DictionaryCompleter	Performs command completion, based on the information available in the command dictionary.
DictionaryContext
HelpGenerator	Provides help based on information from a command dictionary.
InputConversionEngine	This class is responsible for converting strings to objects of a particular class.
LocalBuilders	static utilities to handle LocalCommandDictionary
RawCommand	A command with pre-parsed arguments (Objects).
RoutingCommandSet
TokenizedCommand	A command line that has been split into tokens.

Exception Summary

Exception	Description
CommandInvocationException	An exception thrown when a command invocation fails, either because the command cannot be invoked, or because it was invoked and generated an exception.

Package org.lsst.ccs.command Description

An experimental package for testing possible improvements to the command handling mechanism built-in to the CCS core. This package as been separated off to allow us to rapidly prototype ideas for how the command package can be improved, along the lines discussed in this confluence page and the confluence discussion on annotations.

This work is strongly based on earlier ideas developed by Stuart and Max, using cliche as a simple command shell. Although cliche has been removed from this implementation in favour of custom classes more directly tuned to the CCS requirements the ideas developed in the earlier prototypes remain.