de.vandermeer.skb.base.shell

Interface SkbShell

All Superinterfaces:

CategoryHas, HasPrompt

All Known Implementing Classes:

AbstractShell

public interface SkbShell
extends HasPrompt

A shell with flexible adding of commands and auto-generation of help and other commands.

Since:

v0.0.8

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
default void	addCommandInterpreter(Collection<CommandInterpreter> interpreters) Adds a new collection of command interpreters to the shell.
default boolean	addCommandInterpreter(CommandInterpreter interpreter) Adds a new command interpreter to the shell.
default void	addCommandInterpreter(CommandInterpreter[] interpreters) Adds a new set command interpreters to the shell.
List<String>	getCommandHistory() Returns the command history of the shell, that is the last n commands (n depends on implementation).
Map<String,CommandInterpreter>	getCommandMap() Returns the shell's mapping of commands to associated command interpreters.
Set<String>	getCommands() Returns all commands set for the shell.
default String	getDescription() Returns the description of the shell.
default String	getDisplayName() Returns the display name of the shell.
int	getExitStatus() Returns the exit status of the shell.
String	getID() Returns the identifier of the shell.
MessageMgr	getMessageManager() Returns the shell's message manager.
default String	getPromptName() Returns the prompt name of the shell.
boolean	isRunning() tests if the shell is running.
default int	parseLine(String in) Parses a command line string.
default StrBuilder	prompt()
int	runShell() Runs the shell.
int	runShell(BufferedReader reader) Runs the shell with a particular reader.
Thread	start(Object notify) Starts the shell as a new thread.
void	stop() Stops the shell thread.

Method Detail

addCommandInterpreter

default boolean addCommandInterpreter(CommandInterpreter interpreter)

Adds a new command interpreter to the shell.

Parameters:

interpreter - new command interpreter

Returns:

true on success, false on error (interpreter null, some parameters not set, already set for same command)

addCommandInterpreter

default void addCommandInterpreter(CommandInterpreter[] interpreters)

Adds a new set command interpreters to the shell. Any interpreter that is null will not be set. Any interpreter with missing parameters will not be set.

Parameters:

interpreters - new command interpreters, null array will be ignored

addCommandInterpreter

default void addCommandInterpreter(Collection<CommandInterpreter> interpreters)

Adds a new collection of command interpreters to the shell. Any interpreter that is null will not be set. Any interpreter with missing parameters will not be set.

Parameters:

interpreters - new command interpreters, null collection will be ignored

getDescription

default String getDescription()

Returns the description of the shell.

Returns:

shell description

getDisplayName

default String getDisplayName()

Returns the display name of the shell.

Returns:

display name

getID

String getID()

Returns the identifier of the shell.

Returns:

shell identifier.

getPromptName

default String getPromptName()

Returns the prompt name of the shell.

Returns:

shell short name

getCommandMap

Map<String,CommandInterpreter> getCommandMap()

Returns the shell's mapping of commands to associated command interpreters.

Returns:

mapping of commands to an associated interpreters

getCommands

Set<String> getCommands()

Returns all commands set for the shell.

Returns:

all commands of the shell. The commands should be ordered.

prompt

default StrBuilder prompt()

Specified by:

prompt in interface HasPrompt

parseLine

default int parseLine(String in)

Parses a command line string. If the string is blank or starts with a single line comment character (either '//' or '#'), no action is taken and 0 is returned.

Parameters:

in - command line string with a command

Returns:

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

start

Thread start(Object notify)

Starts the shell as a new thread.

Parameters:

notify - an object to notify if the shell is terminated

Returns:

the created thread for the shell

stop

void stop()

Stops the shell thread.

isRunning

boolean isRunning()

tests if the shell is running.

Returns:

true if the shell is running (started), false otherwise.

getExitStatus

int getExitStatus()

Returns the exit status of the shell.

Returns:

exit status, 0 on normal termination, non-0 otherwise

runShell

int runShell()

Runs the shell.

Returns:

exit status: 0 if the shell run through without errors, greater than 0 otherwise

runShell

int runShell(BufferedReader reader)

Runs the shell with a particular reader.

Parameters:

reader - the reader for the shell

Returns:

exit status: 0 if the shell run through without errors, greater than 0 otherwise

getMessageManager

MessageMgr getMessageManager()

Returns the shell's message manager.

Returns:

the shell's message manager, should not be null

getCommandHistory

List<String> getCommandHistory()

Returns the command history of the shell, that is the last n commands (n depends on implementation).

Returns:

shell command history