de.vandermeer.skb.base.shell

Interface CommandInterpreter

All Known Implementing Classes:

AbstractCommandInterpreter, Ci_Exit, Ci_Help, Ci_HelpStg, Ci_HelpTable, Ci_History, Ci_ScRun, Ci_Wait

public interface CommandInterpreter

An interpreter for a shell command.

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>

Method Summary

Modifier and Type	Method and Description
Map<String,SkbShellCommand>	getCommands() Returns the mapping of commands to SkbShellCommand this interpreter does handle.
Set<String>	getCommandStrings() Returns the set of commands this interpreter does handle.
int	interpretCommand(String command, LineParser lp, MessageMgr mm) Interprets the given command.

Method Detail

interpretCommand

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

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)

getCommandStrings

Set<String> getCommandStrings()

Returns the set of commands this interpreter does handle.

Returns:

set of commands of the command interpreter

getCommands

Map<String,SkbShellCommand> getCommands()

Returns the mapping of commands to SkbShellCommand this interpreter does handle.

Returns:

the mapping, cannot be null