org.lsst.ccs.command

Interface DictionaryHelpGenerator

All Superinterfaces:

Serializable

public interface DictionaryHelpGenerator
extends Serializable

An interface to be implemented by classes providing Help Support for DictionaryCommands.

Author:

turri

Method Summary

Modifier and Type	Method and Description
boolean	hasHelp(DictionaryCommand command) Check if help support is provided for the given command.
String	modifyHelpForCommand(DictionaryCommand command, String help, boolean compact) Modify the current help for the command.

Method Detail

hasHelp

boolean hasHelp(DictionaryCommand command)

Check if help support is provided for the given command.

Parameters:

command - The Dictionary Command.

Returns:

true if help support is provided for the given command.

modifyHelpForCommand

String modifyHelpForCommand(DictionaryCommand command,
                            String help,
                            boolean compact)

Modify the current help for the command.

Parameters:

command - The Dictionary Command.

help - The current help string for the command

compact - True if the version of the help is in compact form.

Returns:

The modified help