de.vandermeer.skb.base.shell

Class Ci_HelpTable

Object

AbstractCommandInterpreter

Ci_Help

Ci_HelpTable

All Implemented Interfaces:

CommandInterpreter

public class Ci_HelpTable
extends Ci_Help

An interpreter for the 'help' shell command using an ASCII table 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

Modifier and Type	Field and Description
protected AT_ColumnWidthCalculator	cwc Table width calculated.
protected TA_Grid	grid The grid for the table.

Fields inherited from class Ci_Help

HELP, HELP_H, HELP_QM, skbShell

Constructor Summary

Constructors

Constructor and Description
Ci_HelpTable(SkbShell skbShell) Returns an new 'help' command interpreter for table output with default grid and columns set to width of 15 and 70.
Ci_HelpTable(SkbShell skbShell, TA_Grid grid) Returns an new 'help' command interpreter for table output.

Method Summary

Modifier and Type	Method and Description
protected void	generalHelp(AsciiTable at) Processes general help with no specific command requested.
int	interpretCommand(String command, LineParser lp, MessageMgr mm) Interprets the given command.
Ci_HelpTable	setWidth(AT_ColumnWidthCalculator cwc) Sets the table with.
protected void	specificHelp(AsciiTable at, 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

Field Detail

grid

protected TA_Grid grid

The grid for the table.

cwc

protected AT_ColumnWidthCalculator cwc

Table width calculated.

Constructor Detail

Ci_HelpTable

public Ci_HelpTable(SkbShell skbShell)

Returns an new 'help' command interpreter for table output with default grid and columns set to width of 15 and 70.

Parameters:

skbShell - the calling shell

Ci_HelpTable

public Ci_HelpTable(SkbShell skbShell,
                    TA_Grid grid)

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

Parameters:

skbShell - the calling shell

grid - a grid for the table

Method Detail

setWidth

public Ci_HelpTable setWidth(AT_ColumnWidthCalculator cwc)

Sets the table with.

Parameters:

cwc - table width calculator to be used

Returns:

self to allow for chaining

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(AsciiTable at,
                            String toHelp)

Processes general help with no specific command requested.

Parameters:

at - table to add help information to

toHelp - the command to help with

generalHelp

protected void generalHelp(AsciiTable at)

Processes general help with no specific command requested.

Parameters:

at - table to add help information to