org.lsst.ccs.command

Class CompositeCommandSet

java.lang.Object

org.lsst.ccs.command.CompositeCommandSet

All Implemented Interfaces:

CommandSet

Direct Known Subclasses:

RouteSelectionCommandSet

public class CompositeCommandSet
extends Object
implements CommandSet

A class which can combine multiple command sets to form one combined command set. Individual command sets can be dynamically added and removed. Command sets can be nested, in that one CompositeCommandSet may include another.

Author:

tonyj

Constructor Summary

Constructors

Constructor and Description
CompositeCommandSet()

Method Summary

Modifier and Type	Method and Description
void	add(CommandSet set) Add a new command set
protected void	add(CommandSet set, boolean checkCommands)
Dictionary	getCommandDictionary() Get the dictionary associated with this command set.
Set<CommandSet>	getCommandSets() Returns the list of command sets.
Object	invoke(BasicCommand command) Invoke a command included in this command set.
void	remove(CommandSet set) Remove a command set

Methods inherited from class java.lang.Object

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

Constructor Detail

CompositeCommandSet

public CompositeCommandSet()

Method Detail

add

public void add(CommandSet set)

Add a new command set

Parameters:

set - The command set to add.

add

protected void add(CommandSet set,
                   boolean checkCommands)

remove

public void remove(CommandSet set)

Remove a command set

Parameters:

set - The command set to be removed.

getCommandSets

public Set<CommandSet> getCommandSets()

Returns the list of command sets.

Returns:

An unmodifiable collection of command sets

getCommandDictionary

public Dictionary getCommandDictionary()

Get the dictionary associated with this command set. If there are multiple command sets included in this composite command set the dictionary will include entries for all of the commands in all of the included command sets.

Specified by:

getCommandDictionary in interface CommandSet

Returns:

The combined dictionary

invoke

public Object invoke(BasicCommand command)
              throws CommandInvocationException,
                     CommandArgumentMatchException,
                     CommandArgumentTypeException

Invoke a command included in this command set.

Specified by:

invoke in interface CommandSet

Parameters:

command - The Command to be invoked

Returns:

The result of executing the command, or null if the command does not return a result.

Throws:

CommandInvocationException - If the command fails, either because it cannot be found, the arguments do not match the expected arguments, or the command fails during invocation.

CommandArgumentMatchException - if one of the provided argument values does not match the allowed values.

CommandArgumentTypeException