org.lsst.ccs.command

Class HelpGenerator

java.lang.Object

org.lsst.ccs.command.HelpGenerator

public class HelpGenerator
extends Object

Provides help based on information from a command dictionary.

Author:

tonyj

Constructor Summary

Constructors

Constructor and Description
HelpGenerator(PrintWriter out, Dictionary dict) Create a HelpGenerator

Method Summary

Modifier and Type	Method and Description
List<String>	getAllowedValues() Used in MethodBasedDictionaryArgument to delegate the fetching of the list of allowed values.
CommandSet	getCommandSet() Return the command set containing the HelpCommands themselves.

Methods inherited from class java.lang.Object

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

Constructor Detail

HelpGenerator

public HelpGenerator(PrintWriter out,
                     Dictionary dict)

Create a HelpGenerator

Parameters:

out - Where the output of the help commands should be sent

dict - The dictionary used to provide help

Method Detail

getCommandSet

public CommandSet getCommandSet()

Return the command set containing the HelpCommands themselves.

Returns:

getAllowedValues

public List<String> getAllowedValues()

Used in MethodBasedDictionaryArgument to delegate the fetching of the list of allowed values.

Returns:

The List of allowed values. Empty if no values are available.