com.jmodule.exec

Class ConsoleClient

java.lang.Object

com.jmodule.exec.ConsoleClient

public class ConsoleClient
extends java.lang.Object

Builds and runs a multi-module command line interface. Please note: This class takes user input by toggling the console between raw input and regular input mode. As of version 1.0.2, this client only officially supports *nix terminals. The client has not yet been tested on windows terminals.

Version:

1.3.1

Author:

Pierce Kelaita

Constructor Summary

Constructors

Constructor and Description
ConsoleClient(java.lang.String appname, Module homeModule) Sets the name of the app and the starting module

Method Summary

Modifier and Type	Method and Description
void	addModule(Module m) Adds a possible module to the client.
void	addShutdownHook(java.lang.Thread onShutdown) Adds a proccess to run when the app shuts down.
void	enableAlerts(boolean enabled) Sets whether the client will trigger the system's default alert sound when the user performs actions that cannot have a result.
void	enableHistoryIndexDisplay(boolean enabled) Sets whether the client will display the history index in the prompt.
void	enableHistoryLogging(boolean enabled) Sets whether the client will log history of user commands.
void	enableTabCompletion(boolean enabled) Sets whether the client will be able to toggle through command history using the tab key
void	removeModule(Module m) Removes a possible module from the client.
void	runConsole() Runs the console application accross all modules, starting from the home module
void	setModuleSeparator(java.lang.String separator) Sets the character(s) that will be shown between the app name and the module in the prompt display.
void	setPromptDisplayName(java.lang.String name) Sets the app name that will show on the prompt display.
void	setPromptSeparator(java.lang.String separator) Sets the character(s) that will come up at the end of the prompt on the CLI to separate the prompt from the user input.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConsoleClient

public ConsoleClient(java.lang.String appname,
                     Module homeModule)

Sets the name of the app and the starting module

Parameters:

appname - The name of the console application

homeModule - The default module that is loaded when user first starts up application

Method Detail

setPromptSeparator

public void setPromptSeparator(java.lang.String separator)

Sets the character(s) that will come up at the end of the prompt on the CLI to separate the prompt from the user input. By default, this separator is "$".

The following examples show two prompts with the same settings but different prompt seprators:

AppName: module$ - separator is set to "$" (default setting)
AppName: module> - separator is set to ">"
AppName: module > - separator is set to " >"

Parameters:

separator -

setModuleSeparator

public void setModuleSeparator(java.lang.String separator)

Sets the character(s) that will be shown between the app name and the module in the prompt display. By default, this separator is ": " - a colon with a space after it. Be advised that this separator will only be displayed if the client has multiple modules.

The following examples show two prompts with the same settings but different module seprators:

AppName: module 0$ - separator is set to ": " (default setting)
AppName/ module 0$ - separator is set to "/ "
AppName/module 0$ - separator is set to "/"

Parameters:

separator -

enableHistoryLogging

public void enableHistoryLogging(boolean enabled)

Sets whether the client will log history of user commands. This value is set to false by default.

Parameters:

historyEnabled - if true, client will log command history

enableHistoryIndexDisplay

public void enableHistoryIndexDisplay(boolean enabled)

Sets whether the client will display the history index in the prompt. This can only be enabled if history logging is enabled and is set to false by default.

Parameters:

enabled - if true, client will display history index in prompt

enableTabCompletion

public void enableTabCompletion(boolean enabled)

Sets whether the client will be able to toggle through command history using the tab key

Parameters:

historyEnabled - if true, client will log command history

enableAlerts

public void enableAlerts(boolean enabled)

Sets whether the client will trigger the system's default alert sound when the user performs actions that cannot have a result. (For example, pressing delete when there are no input characters on the line)

Parameters:

enabled - if true, client will trigger system alerts

setPromptDisplayName

public void setPromptDisplayName(java.lang.String name)

Sets the app name that will show on the prompt display. By default, this value is null, and the prompt display shows the user-given app name with its spaces removed.

Parameters:

name -

addShutdownHook

public void addShutdownHook(java.lang.Thread onShutdown)

Adds a proccess to run when the app shuts down. Define your proccess by overriding the method run() in java.lang.Thread.

Parameters:

onShutdown - Thread containing process to run on shutdown

addModule

public void addModule(Module m)

Adds a possible module to the client. The user can switch to this module by typing its name in the CLI

Parameters:

m - Module to add

removeModule

public void removeModule(Module m)

Removes a possible module from the client.

Parameters:

m - Module to remove

runConsole

public void runConsole()

Runs the console application accross all modules, starting from the home module