de.vandermeer.skb.base.shell

Class Ci_HelpStg

Object

AbstractCommandInterpreter

Ci_Help

Ci_HelpStg

All Implemented Interfaces:

CommandInterpreter

public class Ci_HelpStg
extends Ci_Help

An interpreter for the 'help' shell command using an STG for output.

Since:

v0.0.10

Version:

v0.2.0 build 170404 (04-Apr-17) for Java 1.8

Author:

Sven van der Meer <vdmeer.sven@mykolab.com>

Field Summary

Fields inherited from class Ci_Help

HELP, HELP_H, HELP_QM, skbShell

Constructor Summary

Constructors

Constructor and Description
Ci_HelpStg(SkbShell skbShell) Returns an new 'help' command interpreter for STG output.

Method Summary

Modifier and Type	Method and Description
protected void	generalHelp(IsInfoSetFT info) Processes general help with no specific command requested.
int	interpretCommand(String command, LineParser lp, MessageMgr mm) Interprets the given command.
protected void	specificHelp(IsInfoSetFT info, String toHelp) Processes general help with no specific command requested.

Methods inherited from class AbstractCommandInterpreter

getCommands, getCommandStrings

Methods inherited from class Object

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

Constructor Detail

Ci_HelpStg

public Ci_HelpStg(SkbShell skbShell)

Returns an new 'help' command interpreter for STG output.

Parameters:

skbShell - the calling shell

Method Detail

interpretCommand

public int interpretCommand(String command,
                            LineParser lp,
                            MessageMgr mm)

Description copied from interface: CommandInterpreter

Interprets the given command.

Specified by:

interpretCommand in interface CommandInterpreter

Overrides:

interpretCommand in class Ci_Help

Parameters:

command - command for interpretation

lp - a parser with the whole command line

mm - the message manager to use for reporting errors, warnings, and infos

Returns:

-3 if any of the input parameters was null, blank or not correct -2 if command was found and interpreted but leads to an exit command for the shell, -1 if command not part of this interpreter, 0 if command was found and interpretation was successful and did not lead to an exit command (exit shell), greater than 0 otherwise (command found, interpreted, but some errors occurred)

specificHelp

protected void specificHelp(IsInfoSetFT info,
                            String toHelp)

Processes general help with no specific command requested.

Parameters:

info - the info object to add help to

toHelp - the command to help with

generalHelp

protected void generalHelp(IsInfoSetFT info)

Processes general help with no specific command requested.

Parameters:

info - the info object to add help to