de.vandermeer.skb.base.shell

Class Ci_Help

Object

AbstractCommandInterpreter

Ci_Help

All Implemented Interfaces:

CommandInterpreter

Direct Known Subclasses:

Ci_HelpStg, Ci_HelpTable

public abstract class Ci_Help
extends AbstractCommandInterpreter

An abstract help command interpreter.

Since:

v0.0.12

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

Modifier and Type	Field and Description
static SkbShellCommand	HELP The command for help.
static SkbShellCommand	HELP_H The command for h.
static SkbShellCommand	HELP_QM The command for ?.
protected SkbShell	skbShell The calling shell, needed to parse lines.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
int	interpretCommand(String command, LineParser lp, MessageMgr mm) Interprets the given command.

Methods inherited from class AbstractCommandInterpreter

getCommands, getCommandStrings

Methods inherited from class Object

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

Field Detail

HELP

public static final SkbShellCommand HELP

The command for help.

HELP_H

public static final SkbShellCommand HELP_H

The command for h.

HELP_QM

public static final SkbShellCommand HELP_QM

The command for ?.

skbShell

protected final SkbShell skbShell

The calling shell, needed to parse lines.

Constructor Detail

Ci_Help

public Ci_Help(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.

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)