sfi.director.cli.help Class Reference

Implements the 'help' director command. More...

Inheritance diagram for sfi.director.cli.help:

Public Member Functions
String	usage ()
	return a one-line usage string
String	help ()
	return a more verbose usage string (aka.
String[]	getOptDefinitions ()
	return option definitions as used by Tools.getOpt()
void	help (String commandName, boolean verbose, boolean rawopts) throws DirectorException
void	run (Hashtable optvals) throws DirectorException
	run the command with the (pre-parsed) options optargs
Public Member Functions inherited from sfi.director.cli.CLICommand
void	setOptions (Hashtable opts)
	sets options from a hash as returned by Tools.getOpts().
Options	getOptions ()
Hashtable	getOptionsHash ()

Detailed Description

Implements the 'help' director command.

Constructor & Destructor Documentation

String sfi.director.cli.help.help ( )

virtual

return a more verbose usage string (aka.

help)

Implements sfi.director.cli.CLICommand.

Referenced by sfi.director.cli.help.run().

void sfi.director.cli.help.help	(	String	commandName,
		boolean	verbose,
		boolean	rawopts
	)		throws DirectorException

References sfi.director.cli.CLICommand.getOptDefinitions(), sfi.director.cli.CLICommand.help(), sfi.director.util.Tools.split(), and sfi.director.cli.CLICommand.usage().

Member Function Documentation

String [] sfi.director.cli.help.getOptDefinitions ( )

virtual

return option definitions as used by Tools.getOpt()

Implements sfi.director.cli.CLICommand.

void sfi.director.cli.help.run ( Hashtable  optargs ) throws DirectorException

virtual

run the command with the (pre-parsed) options optargs

Implements sfi.director.cli.CLICommand.

References sfi.director.cli.help.help().

String sfi.director.cli.help.usage ( )

virtual

return a one-line usage string

Implements sfi.director.cli.CLICommand.

---

The documentation for this class was generated from the following file:

• director/src/sfi/director/cli/help.java