org.lsst.ccs.shell
Class HelpCommandHandler

java.lang.Object
  org.lsst.ccs.shell.HelpCommandHandler

All Implemented Interfaces:

ShellDependent

public class HelpCommandHandler
extends Object
implements ShellDependent

Help command handler (usually prefixed by '?').

Author:

ASG

Constructor Summary

HelpCommandHandler()

Method Summary

void	cliSetShell(Shell theShell) This method informs the object about the Shell operating it.
String	generateHTMLHelp(String fileName, boolean includePrefixed)
Object	help()
Object	help(String commandName)
List<String>	list()
List<String>	list(String startsWith)
List<String>	listAll()

Methods inherited from class java.lang.Object

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

Constructor Detail

HelpCommandHandler

public HelpCommandHandler()

Method Detail

cliSetShell

public void cliSetShell(Shell theShell)

Description copied from interface: ShellDependent

This method informs the object about the Shell operating it. Is called upon object's registration in Shell.

Specified by:

cliSetShell in interface ShellDependent

Parameters:

theShell - Shell running the object.

listAll

public List<String> listAll()

list

public List<String> list()

generateHTMLHelp

public String generateHTMLHelp(String fileName,
                               boolean includePrefixed)
                        throws IOException

Throws:

IOException

list

public List<String> list(String startsWith)

help

public Object help()

help

public Object help(String commandName)