org.lsst.ccs.command

Class CompositeCommandDictionary

java.lang.Object

org.lsst.ccs.command.CompositeCommandDictionary

All Implemented Interfaces:

Serializable, Iterable<DictionaryCommand>, Dictionary

public class CompositeCommandDictionary
extends Object
implements Dictionary

A command dictionary to which other command dictionaries can be added and removed.

Author:

tonyj

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CompositeCommandDictionary()

Method Summary

Methods

Modifier and Type	Method and Description
void	add(Dictionary commandDictionary)
boolean	containsCommand(BasicCommand tc) Test if a given command is present in a dictionary.
boolean	containsCommand(String command, int argumentCount) Test if a given command is present in a dictionary
DictionaryCommand	findCommand(BasicCommand tc) Find a given command in the dictionary
DictionaryCommand	findCommand(String command, int argumentCount) Find a given command in the dictionary.
Iterator<DictionaryCommand>	iterator()
void	remove(Dictionary commandDictionary)
int	size() The size of the dictionary.

Methods inherited from class java.lang.Object

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

Constructor Detail

CompositeCommandDictionary

public CompositeCommandDictionary()

Method Detail

add

public void add(Dictionary commandDictionary)

remove

public void remove(Dictionary commandDictionary)

containsCommand

public boolean containsCommand(BasicCommand tc)

Description copied from interface: Dictionary

Test if a given command is present in a dictionary.

Specified by:

containsCommand in interface Dictionary

Parameters:

tc - The command (or alias) to search for

Returns:

trueIf the command is found

findCommand

public DictionaryCommand findCommand(BasicCommand tc)

Description copied from interface: Dictionary

Find a given command in the dictionary

Specified by:

findCommand in interface Dictionary

Parameters:

tc - The command (or alias) to search for

Returns:

The DictionaryCommand, or null if the command is not found.

containsCommand

public boolean containsCommand(String command,
                      int argumentCount)

Description copied from interface: Dictionary

Test if a given command is present in a dictionary

Specified by:

containsCommand in interface Dictionary

Parameters:

command - The command (or alias) to search for

argumentCount - The number of arguments associated with the command

Returns:

trueIf the command is found

findCommand

public DictionaryCommand findCommand(String command,
                            int argumentCount)

Description copied from interface: Dictionary

Find a given command in the dictionary.

Specified by:

findCommand in interface Dictionary

Parameters:

command - The command (or alias) to search for

argumentCount - The number of arguments associated with the command

Returns:

The DictionaryCommand, or null if the command is not found.

iterator

public Iterator<DictionaryCommand> iterator()

Specified by:

iterator in interface Iterable<DictionaryCommand>

size

public int size()

Description copied from interface: Dictionary

The size of the dictionary.

Specified by:

size in interface Dictionary

Returns:

The number of commands in this dictionary.