org.lsst.ccs.command

Interface Dictionary

All Superinterfaces:

Iterable<DictionaryCommand>

public interface Dictionary
extends Iterable<DictionaryCommand>

A command dictionary contains all the information needed to provide help and perform tab completion. It does not by itself provide sufficient functionality to invoke a command, for this a CommandSet which is a combination of a command dictionary and a command invoker is required. A CommandDictionary is a collection of CommandDefinitions, plus a few convenience methods.

Author:

tonyj

Method Summary

Methods

Modifier and Type	Method and Description
boolean	containsCommand(BasicCommand command) 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
int	findCommand(BasicCommand command) Find a given command in the dictionary
int	findCommand(String command, int argumentCount) Find a given command in the dictionary.
DictionaryCommand	get(int index) Get the command at the given index.
int	size() The size of the dictionary.

Methods inherited from interface java.lang.Iterable

iterator

Method Detail

containsCommand

boolean containsCommand(BasicCommand command)

Test if a given command is present in a dictionary.

Parameters:

command - The command (or alias) to search for

Returns:

trueIf the command is found

findCommand

int findCommand(BasicCommand command)

Find a given command in the dictionary

Parameters:

command - The command (or alias) to search for

Returns:

The index of the command in the dictionary, or -1 if the command is not found.

containsCommand

boolean containsCommand(String command,
                      int argumentCount)

Test if a given command is present in a 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

int findCommand(String command,
              int argumentCount)

Find a given command in the dictionary.

Parameters:

command - The command (or alias) to search for

argumentCount - The number of arguments associated with the command

Returns:

The index of the command in the dictionary, or -1 if the command is not found.

size

int size()

The size of the dictionary.

Returns:

The number of commands in this dictionary.

get

DictionaryCommand get(int index)
                      throws IndexOutOfBoundsException

Get the command at the given index.

Parameters:

index -

Returns:

The command found

Throws:

IndexOutOfBoundsException - If the index is out of bounds.