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.
default Iterable<DictionaryCommand>	filterByVisibilityIterator() An iterator over DictionaryCommand of this dictionary that filters by level.
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	getLevelForType(Command.CommandType type) Get the visibility level for this dictionary for the given CommandType.
boolean	isCategoryVisible(Command.CommandCategory category) Get the visibility for the provided CommandCategory.
default boolean	isDictionaryCommandVisible(DictionaryCommand dc)
void	setCategoryVisible(Command.CommandCategory category, boolean isVisible) Turn on/off the visibility of a given CommandCategory.
void	setLevelForTypes(int level, Command.CommandType... types) Set the visibility level for this dictionary for the provided CommandTypes.
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.

setLevelForTypes

void setLevelForTypes(int level,
                      Command.CommandType... types)

Set the visibility level for this dictionary for the provided CommandTypes. A negative level will make the provided types not visible. A positive level will consider all types of commands with level up to level for all the specified CommandTypes

Parameters:

level - the level to set.

types - a list of types.

getLevelForType

int getLevelForType(Command.CommandType type)

Get the visibility level for this dictionary for the given CommandType.

Parameters:

type - the command type

Returns:

the level

setCategoryVisible

void setCategoryVisible(Command.CommandCategory category,
                        boolean isVisible)

Turn on/off the visibility of a given CommandCategory. By default commands annotated with SYSTEM category are not visible to the user.

Parameters:

category - The CommandCategory.

isVisible - true/false to turn the visibility on/off

isCategoryVisible

boolean isCategoryVisible(Command.CommandCategory category)

Get the visibility for the provided CommandCategory.

Parameters:

category - The provided CommandCategory.

Returns:

true/false if the CommandCategory is visible or not.

isDictionaryCommandVisible

default boolean isDictionaryCommandVisible(DictionaryCommand dc)

filterByVisibilityIterator

default Iterable<DictionaryCommand> filterByVisibilityIterator()

An iterator over DictionaryCommand of this dictionary that filters by level.

Returns: