gov.llnl.babel.cli

Interface CommandLineDictionary

All Known Implementing Classes:

SwitchDictionary

public interface CommandLineDictionary

This interface is used to add CommandLineSwitch objects to the dictionary of all command line switches. Each command line switch must be added during Babel's startup.

Method Summary

Methods

Modifier and Type	Method and Description
void	addCommandLineSwitch(CommandLineSwitch cls) Add a command line switch to the dictionary of available command line switches.

Method Detail

addCommandLineSwitch

void addCommandLineSwitch(CommandLineSwitch cls)
                          throws NameCollisionException

Add a command line switch to the dictionary of available command line switches. Babel requires that each command line switch have a unique long name. Given that short names are limited, it allocates abbreviated forms on a first come first served basis.

Parameters:

cls - a non-null command line switch to add to the dictionary.

Throws:

NameCollisionException - this indicates that cls has the same long name as a CommandLineSwitch already in the dictionary. This exception is never generated due to collisions in the short form.