de.vandermeer.skb.base.shell

Class Ci_ScRun

Object

AbstractCommandInterpreter

Ci_ScRun

All Implemented Interfaces:

CommandInterpreter

public class Ci_ScRun
extends AbstractCommandInterpreter

An interpreter for the 'run' 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>

Field Summary

Fields

Modifier and Type	Field and Description
static SkbShellArgument	ARG_DIRECTORY The argument for directory names.
static SkbShellArgument	ARG_SCRIPT_INFO The argument for script file names for info.
static SkbShellArgument	ARG_SCRIPT_RUN The argument for script file names for run.
protected String	lastScript Last script run by the shell.
protected boolean	printProgress Flag for printing progress during script execution.
static SkbShellCommand	SC_INFO The command for info on scripts.
static SkbShellCommand	SC_LS The command for ls on scripts.
static SkbShellCommand	SC_RUN The command for running scripts.
static String	SCRIPT_FILE_EXTENSION Extension for script files.
protected SkbShell	skbShell The calling shell, needed to parse lines.

Constructor Summary

Constructors

Constructor and Description
Ci_ScRun(boolean printProgress, SkbShell skbShell) Returns an new 'run' command interpreter.
Ci_ScRun(SkbShell skbShell) Returns an new 'run' command interpreter which will print progress information.

Method Summary

Modifier and Type	Method and Description
protected String	getContent(String fileName, MessageMgr mm) Returns the content of a string read from a file.
protected String	getFileName(LineParser lp) Returns a file name taken as argument from the line parser with fixed extension
int	interpretCommand(String command, LineParser lp, MessageMgr mm) Interprets the given command.
protected int	interpretInfo(LineParser lp, MessageMgr mm) Interprets the actual info command
protected int	interpretLs(LineParser lp, MessageMgr mm) Interprets the actual ls command
protected int	interpretRun(LineParser lp, MessageMgr mm) Interprets the actual run 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

lastScript

protected String lastScript

Last script run by the shell.

printProgress

protected boolean printProgress

Flag for printing progress during script execution.

skbShell

protected final SkbShell skbShell

The calling shell, needed to parse lines.

SCRIPT_FILE_EXTENSION

public static String SCRIPT_FILE_EXTENSION

Extension for script files.

ARG_SCRIPT_RUN

public static final SkbShellArgument ARG_SCRIPT_RUN

The argument for script file names for run.

ARG_SCRIPT_INFO

public static final SkbShellArgument ARG_SCRIPT_INFO

The argument for script file names for info.

ARG_DIRECTORY

public static final SkbShellArgument ARG_DIRECTORY

The argument for directory names.

SC_RUN

public static final SkbShellCommand SC_RUN

The command for running scripts.

SC_INFO

public static final SkbShellCommand SC_INFO

The command for info on scripts.

SC_LS

public static final SkbShellCommand SC_LS

The command for ls on scripts.

Constructor Detail

Ci_ScRun

public Ci_ScRun(SkbShell skbShell)

Returns an new 'run' command interpreter which will print progress information.

Parameters:

skbShell - the calling shell

Ci_ScRun

public Ci_ScRun(boolean printProgress,
                SkbShell skbShell)

Returns an new 'run' command interpreter.

Parameters:

printProgress - flag for printing progress when executing commands from a file, true for yes, false for no

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)

interpretInfo

protected int interpretInfo(LineParser lp,
                            MessageMgr mm)

Interprets the actual info command

Parameters:

lp - line parser

mm - the message manager to use for reporting errors, warnings, and infos

Returns:

0 for success, non-zero otherwise

interpretLs

protected int interpretLs(LineParser lp,
                          MessageMgr mm)

Interprets the actual ls command

Parameters:

lp - line parser

mm - the message manager to use for reporting errors, warnings, and infos

Returns:

0 for success, non-zero otherwise

interpretRun

protected int interpretRun(LineParser lp,
                           MessageMgr mm)

Interprets the actual run command

Parameters:

lp - line parser

mm - the message manager to use for reporting errors, warnings, and infos

Returns:

0 for success, non-zero otherwise

getFileName

protected String getFileName(LineParser lp)

Returns a file name taken as argument from the line parser with fixed extension

Parameters:

lp - line parser

Returns:

file name, null if none found

getContent

protected String getContent(String fileName,
                            MessageMgr mm)

Returns the content of a string read from a file.

Parameters:

fileName - name of file to read from

mm - the message manager to use for reporting errors, warnings, and infos

Returns:

null if no content could be found (error), content in string otherwise