cli

Class Shell

java.lang.Object

cli.NativeObject

cli.ExecutionContext.Common

cli.ExecutionContext.Native

cli.Shell

All Implemented Interfaces:

ExecutionContext.Interface

public class Shell
extends ExecutionContext.Native

Shell class. A shell basically runs a command line interface with the following arguments at the minimum: # a Cli object which defines a set of command lines and the execution for each of them; # an IODevice used to receive the input characters and to print out characters.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALL_STREAMS All streams constant.
static int	ECHO_STREAM Echo stream constant.
static int	ERROR_STREAM Error stream constant.
static int	OUTPUT_STREAM Output stream constant.
static int	PROMPT_STREAM Prompt stream constant.
static int	STREAM_TYPES_COUNT Number of stream types.
static int	WELCOME_STREAM Welcome stream constant.

Constructor Summary

Constructors

Constructor and Description
Shell(Cli CLI_Cli) Top execution context constructor.
Shell(ExecutionContext.Interface CLI_ParentContext, Cli CLI_Cli) Child execution context constructor.

Method Summary

Modifier and Type	Method and Description
void	cleanScreen(boolean B_PromptMenu) Cleans the screen.
void	displayHelp() Displays help depending on the context of the current line.
void	enterMenu(Menu CLI_Menu, boolean B_PromptMenu) Enter a menu.
void	exitMenu(boolean B_PromptMenu) Exits the current menu.
Cli	getCli() Cli accessor.
Menu	getCurrentMenu(int I_MenuIndex) Current menu retrieval.
int	getHelpMargin() Help margin accessor.
int	getHelpOffset() Help offset accessor.
void	printWorkingMenu() Prints the working menu.
void	quit() Terminates the shell.
void	setByeMessage(ResourceString CLI_ByeMessage) Bye message setting.
void	setPrompt(ResourceString CLI_Prompt) Prompt message positionning.
void	setWelcomeMessage(ResourceString CLI_WelcomeMessage) Welcome message setting.

Methods inherited from class cli.ExecutionContext.Common

enableStream, getBeep, getInput, getLang, getStream, isRunning, run, run, setBeep, setLang, setStream, stopAllExecutions, stopExecution, streamEnabled, watchResult

Methods inherited from class cli.NativeObject

createdFromNative, dontFinalize, finalize, forget, getbDoFinalize, getNativeRef, getObject, remember

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface cli.ExecutionContext.Interface

getNativeRef

Field Detail

ALL_STREAMS

public static final int ALL_STREAMS

All streams constant.

See Also:

Constant Field Values

WELCOME_STREAM

public static final int WELCOME_STREAM

Welcome stream constant. Useful for bye too.

See Also:

Constant Field Values

PROMPT_STREAM

public static final int PROMPT_STREAM

Prompt stream constant.

See Also:

Constant Field Values

ECHO_STREAM

public static final int ECHO_STREAM

Echo stream constant.

See Also:

Constant Field Values

OUTPUT_STREAM

public static final int OUTPUT_STREAM

Output stream constant.

See Also:

Constant Field Values

ERROR_STREAM

public static final int ERROR_STREAM

Error stream constant.

See Also:

Constant Field Values

STREAM_TYPES_COUNT

public static final int STREAM_TYPES_COUNT

Number of stream types.

See Also:

Constant Field Values

Constructor Detail

Shell

public Shell(Cli CLI_Cli)

Top execution context constructor.

Parameters:

CLI_Cli - Cli structure the shell will run the text based interface for.

Shell

public Shell(ExecutionContext.Interface CLI_ParentContext,
             Cli CLI_Cli)

Child execution context constructor.

Parameters:

CLI_ParentContext - Parent execution context.

CLI_Cli - Cli structure the shell will run the text based interface for.

Method Detail

getCli

public final Cli getCli()

Cli accessor.

Returns:

The CLI instance the shell is running with.

setWelcomeMessage

public final void setWelcomeMessage(ResourceString CLI_WelcomeMessage)

Welcome message setting.

Parameters:

CLI_WelcomeMessage - Welcome message. When an empty string is given, the default welcome message is restored.

setByeMessage

public final void setByeMessage(ResourceString CLI_ByeMessage)

Bye message setting.

Parameters:

CLI_ByeMessage - Bye message. When an empty string is given, the default bye message is restored.

setPrompt

public final void setPrompt(ResourceString CLI_Prompt)

Prompt message positionning.

Parameters:

CLI_Prompt - Prompt string. When an empty string is given, the default prompt (depending on the current menu) is restored.

getHelpMargin

public final int getHelpMargin()

Help margin accessor.

Returns:

Number of spaces for the help margin.

getHelpOffset

public final int getHelpOffset()

Help offset accessor.

Returns:

Number of spaces for the help offset.

getCurrentMenu

public Menu getCurrentMenu(int I_MenuIndex)

Current menu retrieval.

Parameters:

I_MenuIndex - Index of the menu in the stack. 0: root menu (bottom of the stack). 1: menu stacked over the root menu. 2: menu stacked over again... -1: current menu (top of the stack)

Returns:

Reference of the current menu. null when I_MenuIndex is out of bounds.

enterMenu

public final void enterMenu(Menu CLI_Menu,
                            boolean B_PromptMenu)

Enter a menu.

Parameters:

CLI_Menu - Menu to enter.

B_PromptMenu - true if the menu should be (re)prompted. Basically false when executed within the context of a command processing, true when executed from other contexts.

exitMenu

public final void exitMenu(boolean B_PromptMenu)

Exits the current menu.

Parameters:

B_PromptMenu - true if the menu should be (re)prompted. Basically false when executed within the context of a command processing, true when executed from other contexts.

quit

public final void quit()

Terminates the shell. Caution! Not thread safe. Call quitThreadSafe() to do so.

displayHelp

public final void displayHelp()

Displays help depending on the context of the current line.

printWorkingMenu

public final void printWorkingMenu()

Prints the working menu.

cleanScreen

public final void cleanScreen(boolean B_PromptMenu)

Cleans the screen.

Parameters:

B_PromptMenu - true if the menu should be (re)prompted. Basically false when executed within the context of a command processing, true when executed from other contexts.