AbstractShell (SKB Base 0.2.0 API)

Object
- AbstractShell

All Implemented Interfaces:

SkbShell, CategoryHas, HasPrompt
```
public class AbstractShell
extends Object
implements SkbShell
```
An abstract shell implementation with all basic features, use the SkbShellFactory or a sub-class to create a new object.

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
Modifier and Type	Field and Description
`protected Map<String,CommandInterpreter>`	`commandMap` Mapping of a set of commands to an associated command interpreter.
`protected int`	`exitStatus` The shell's exit status.
`protected List<String>`	`history` Command history of the shell, that is the last n commands.
`protected String`	`id` The shell's identifier.
`protected boolean`	`isRunning` Flag indicating if the shell is running.
`protected MessageMgr`	`mm` The shell's message manager.
`protected Object`	`notify` An object for notifications.
`protected Thread`	`thread` A thread for the shell.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AbstractShell()` Returns a new shell with the default identifier and the default STG and console activated.
`protected`	`AbstractShell(MessageRenderer renderer)` Returns a new shell with the default identifier and the given STG and console activated.
`protected`	`AbstractShell(MessageRenderer renderer, boolean useConsole)` Returns a new shell with given STG and console flag.
`protected`	`AbstractShell(String id)` Returns a new shell with a given identifier, standard STGroup and console activated.
`protected`	`AbstractShell(String id, boolean useConsole)` Returns a new shell with given identifier and console flag with standard STGroup.
`protected`	`AbstractShell(String id, MessageRenderer renderer)` Returns a new shell with a given identifier and STGroup plus console activated.
`protected`	`AbstractShell(String id, MessageRenderer renderer, boolean useConsole)` Returns a new shell with given identifier and console flag.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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.
`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.
`boolean`	`isRunning()` tests if the shell is running.
`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.

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface SkbShell
addCommandInterpreter, addCommandInterpreter, addCommandInterpreter, getDescription, getDisplayName, getPromptName, parseLine, prompt

- Field Detail
  - commandMap
```
protected final Map<String,CommandInterpreter> commandMap
```
    Mapping of a set of commands to an associated command interpreter.
  - mm
```
protected final MessageMgr mm
```
    The shell's message manager.
  - isRunning
```
protected boolean isRunning
```
    Flag indicating if the shell is running.
  - exitStatus
```
protected int exitStatus
```
    The shell's exit status.
  - thread
```
protected Thread thread
```
    A thread for the shell.
  - notify
```
protected Object notify
```
    An object for notifications.
  - id
```
protected String id
```
    The shell's identifier.
  - history
```
protected final List<String> history
```
    Command history of the shell, that is the last n commands.
- Constructor Detail
  - AbstractShell
```
protected AbstractShell()
```
    Returns a new shell with the default identifier and the default STG and console activated.
  - AbstractShell
```
protected AbstractShell(MessageRenderer renderer)
```
    Returns a new shell with the default identifier and the given STG and console activated.
    
    Parameters:
    
    renderer - a renderer for help messages
    
    Throws:
    
    IllegalArgumentException - if the STG did not validate
  - AbstractShell
```
protected AbstractShell(MessageRenderer renderer,
                        boolean useConsole)
```
    Returns a new shell with given STG and console flag.
    
    Parameters:
    
    renderer - a renderer for help messages
    
    useConsole - flag to use (true) or not to use (false) console, of false then no output will happen (except for errors on runShell() and some help commands)
  - AbstractShell
```
protected AbstractShell(String id)
```
    Returns a new shell with a given identifier, standard STGroup and console activated.
    
    Parameters:
    
    id - new shell with identifier
    
    Throws:
    
    IllegalArgumentException - if the STG did not validate
  - AbstractShell
```
protected AbstractShell(String id,
                        boolean useConsole)
```
    Returns a new shell with given identifier and console flag with standard STGroup.
    
    Parameters:
    
    id - new shell with identifier
    
    useConsole - flag to use (true) or not to use (false) console, of false then no output will happen
  - AbstractShell
```
protected AbstractShell(String id,
                        MessageRenderer renderer)
```
    Returns a new shell with a given identifier and STGroup plus console activated.
    
    Parameters:
    
    id - new shell with identifier
    
    renderer - a renderer for help messages
    
    Throws:
    
    IllegalArgumentException - if the STG did not validate
  - AbstractShell
```
protected AbstractShell(String id,
                        MessageRenderer renderer,
                        boolean useConsole)
```
    Returns a new shell with given identifier and console flag.
    
    Parameters:
    
    id - new shell with identifier
    
    renderer - a renderer for help messages
    
    useConsole - flag to use (true) or not to use (false) console, of false then no output will happen
- Method Detail
  - getID
```
public String getID()
```
    Description copied from interface: SkbShell
    
    Returns the identifier of the shell.
    
    Specified by:
    
    getID in interface SkbShell
    
    Returns:
    
    shell identifier.
  - getCommandMap
```
public Map<String,CommandInterpreter> getCommandMap()
```
    Description copied from interface: SkbShell
    
    Returns the shell's mapping of commands to associated command interpreters.
    
    Specified by:
    
    getCommandMap in interface SkbShell
    
    Returns:
    
    mapping of commands to an associated interpreters
  - getCommands
```
public Set<String> getCommands()
```
    Description copied from interface: SkbShell
    
    Returns all commands set for the shell.
    
    Specified by:
    
    getCommands in interface SkbShell
    
    Returns:
    
    all commands of the shell. The commands should be ordered.
  - start
```
public Thread start(Object notify)
```
    Description copied from interface: SkbShell
    
    Starts the shell as a new thread.
    
    Specified by:
    
    start in interface SkbShell
    
    Parameters:
    
    notify - an object to notify if the shell is terminated
    
    Returns:
    
    the created thread for the shell
  - stop
```
public void stop()
```
    Description copied from interface: SkbShell
    
    Stops the shell thread.
    
    Specified by:
    
    stop in interface SkbShell
  - isRunning
```
public boolean isRunning()
```
    Description copied from interface: SkbShell
    
    tests if the shell is running.
    
    Specified by:
    
    isRunning in interface SkbShell
    
    Returns:
    
    true if the shell is running (started), false otherwise.
  - getExitStatus
```
public int getExitStatus()
```
    Description copied from interface: SkbShell
    
    Returns the exit status of the shell.
    
    Specified by:
    
    getExitStatus in interface SkbShell
    
    Returns:
    
    exit status, 0 on normal termination, non-0 otherwise
  - runShell
```
public int runShell(BufferedReader reader)
```
    Description copied from interface: SkbShell
    
    Runs the shell with a particular reader.
    
    Specified by:
    
    runShell in interface SkbShell
    
    Parameters:
    
    reader - the reader for the shell
    
    Returns:
    
    exit status: 0 if the shell run through without errors, greater than 0 otherwise
  - runShell
```
public int runShell()
```
    Description copied from interface: SkbShell
    
    Runs the shell.
    
    Specified by:
    
    runShell in interface SkbShell
    
    Returns:
    
    exit status: 0 if the shell run through without errors, greater than 0 otherwise
  - getMessageManager
```
public MessageMgr getMessageManager()
```
    Description copied from interface: SkbShell
    
    Returns the shell's message manager.
    
    Specified by:
    
    getMessageManager in interface SkbShell
    
    Returns:
    
    the shell's message manager, should not be null
  - getCommandHistory
```
public List<String> getCommandHistory()
```
    Description copied from interface: SkbShell
    
    Returns the command history of the shell, that is the last n commands (n depends on implementation).
    
    Specified by:
    
    getCommandHistory in interface SkbShell
    
    Returns:
    
    shell command history

Class AbstractShell

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Methods inherited from interface SkbShell

Field Detail

commandMap

mm

isRunning

exitStatus

thread

notify

id

history

Constructor Detail

AbstractShell

AbstractShell

AbstractShell

AbstractShell

AbstractShell

AbstractShell

AbstractShell

Method Detail

getID

getCommandMap

getCommands

start

stop

isRunning

getExitStatus

runShell

runShell

getMessageManager

getCommandHistory