org.lsst.ccs.command

Interface Dictionary

All Superinterfaces:

Iterable<DictionaryCommand>, Serializable

All Known Implementing Classes:

CompositeCommandDictionary

public interface Dictionary
extends Iterable<DictionaryCommand>, Serializable

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

Modifier and Type	Method and Description
boolean	containsCommand(BasicCommand command) Test if a given command is present in a dictionary.
DictionaryCommand	findCommand(BasicCommand command) Find a given command in the dictionary
default DictionaryCompleter	getDictionaryCompleter() Get the DictionaryCompleter for this Dictionary.
default DictionaryHelpGenerator	getHelpGenerator() Get the DictionaryHelpGenerator for this Dictionary.
int	size() The size of the dictionary.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

containsCommand

boolean containsCommand(BasicCommand command)
                 throws CommandArgumentMatchException

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

Throws:

CommandArgumentMatchException - if there is an illegal argument.

findCommand

DictionaryCommand findCommand(BasicCommand command)
                       throws CommandArgumentMatchException

Find a given command in the dictionary

Parameters:

command - The command (or alias) to search for

Returns:

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

Throws:

CommandArgumentMatchException - if there is an illegal argument.

size

int size()

The size of the dictionary.

Returns:

The number of commands in this dictionary.

getHelpGenerator

default DictionaryHelpGenerator getHelpGenerator()

Get the DictionaryHelpGenerator for this Dictionary.

Returns:

The DictionaryHelpGenerator. null if none is available.

getDictionaryCompleter

default DictionaryCompleter getDictionaryCompleter()

Get the DictionaryCompleter for this Dictionary.

Returns:

The DictionaryCompleter for this Dictionary.