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	getLevel() Get the visibility level for this dictionary.
boolean	getVisibilityForType(Command.CommandType type) Get the type related visibility of a command that belongs to this dictionary.
Iterator<DictionaryCommand>	iterator()
void	remove(Dictionary commandDictionary)
void	setLevel(int level) Set the visibility level for this dictionary.
void	setVisibilityForTypes(Command.CommandType... types) Specified command types will be visible, other ones will not be visible
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

filterByLevelIterator

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.

getLevel

public int getLevel()

Description copied from interface: Dictionary

Get the visibility level for this dictionary.

Specified by:

getLevel in interface Dictionary

Returns:

the level

setLevel

public void setLevel(int level)

Description copied from interface: Dictionary

Set the visibility level for this dictionary. A negative level will consider level 0 QUERY commands only. A positive level will consider all types of commands with level up to level.

Specified by:

setLevel in interface Dictionary

Parameters:

level - the level to set.

getDictionaries

public Set<Dictionary> getDictionaries()

setVisibilityForTypes

public void setVisibilityForTypes(Command.CommandType... types)

Description copied from interface: Dictionary

Specified command types will be visible, other ones will not be visible

Specified by:

setVisibilityForTypes in interface Dictionary

Parameters:

types - a list of types.

getVisibilityForType

public boolean getVisibilityForType(Command.CommandType type)

Description copied from interface: Dictionary

Get the type related visibility of a command that belongs to this dictionary.

Specified by:

getVisibilityForType in interface Dictionary

Parameters:

type - the command type to get the visibility for.

Returns:

true if this command type is visible for this dictionary.