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

Modifier and Type	Method and Description
void	add(Dictionary commandDictionary)
boolean	containsCommand(BasicCommand tc) Test if a given command is present in a dictionary.
DictionaryCommand	findCommand(BasicCommand tc) Find a given command in the dictionary
Set<Dictionary>	getDictionaries()
DictionaryCompleter	getDictionaryCompleter() Get the DictionaryCompleter for this Dictionary.
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.
Iterator<DictionaryCommand>	iterator()
void	remove(Dictionary commandDictionary)
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 class java.lang.Object

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

Methods inherited from interface org.lsst.ccs.command.Dictionary

filterByVisibilityIterator, isDictionaryCommandVisible

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

CompositeCommandDictionary

public CompositeCommandDictionary()

Method Detail

add

public void add(Dictionary commandDictionary)

remove

public void remove(Dictionary commandDictionary)

getDictionaryCompleter

public DictionaryCompleter getDictionaryCompleter()

Description copied from interface: Dictionary

Get the DictionaryCompleter for this Dictionary.

Specified by:

getDictionaryCompleter in interface Dictionary

Returns:

The DictionaryCompleter for this Dictionary.

containsCommand

public boolean containsCommand(BasicCommand tc)
                        throws CommandArgumentMatchException

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

Throws:

CommandArgumentMatchException - if there is an illegal argument.

findCommand

public DictionaryCommand findCommand(BasicCommand tc)
                              throws CommandArgumentMatchException

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.

Throws:

CommandArgumentMatchException - if there is an illegal argument.

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.

getHelpGenerator

public DictionaryHelpGenerator getHelpGenerator()

Description copied from interface: Dictionary

Get the DictionaryHelpGenerator for this Dictionary.

Specified by:

getHelpGenerator in interface Dictionary

Returns:

The DictionaryHelpGenerator. null if none is available.

getDictionaries

public Set<Dictionary> getDictionaries()

setLevelForTypes

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

Description copied from interface: Dictionary

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

Specified by:

setLevelForTypes in interface Dictionary

Parameters:

level - the level to set.

types - a list of types.

getLevelForType

public int getLevelForType(Command.CommandType type)

Description copied from interface: Dictionary

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

Specified by:

getLevelForType in interface Dictionary

Parameters:

type - the command type

Returns:

the level

setCategoryVisible

public void setCategoryVisible(Command.CommandCategory category,
                               boolean isVisible)

Description copied from interface: Dictionary

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

Specified by:

setCategoryVisible in interface Dictionary

Parameters:

category - The CommandCategory.

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

isCategoryVisible

public boolean isCategoryVisible(Command.CommandCategory category)

Description copied from interface: Dictionary

Get the visibility for the provided CommandCategory.

Specified by:

isCategoryVisible in interface Dictionary

Parameters:

category - The provided CommandCategory.

Returns:

true/false if the CommandCategory is visible or not.