cli

Class Cli

java.lang.Object

cli.NativeObject

cli.Element

cli.SyntaxNode

cli.Menu

cli.Cli

public abstract class Cli
extends Menu

Command Line Interface class.

Constructor Summary

Constructors

Constructor and Description
Cli(java.lang.String J_Name, Help CLI_Help) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	addCommentLinePattern(java.lang.String J_Start) Comment line pattern addition.
Menu	addMenu(Menu CLI_Menu) Menu addition.
void	enableConfigMenu(boolean B_Enable) Configuration menu enabling.
static int	findFromName(java.util.Collection<Cli> J_CliList, java.lang.String J_RegExp) Find from name.
Menu	getMenu(java.lang.String J_MenuName) Menu retrieval.
java.lang.String	getName() Name accessor.
boolean	isConfigMenuEnabled() Determines whether the configuration menu is currently enabled.
static void	load() Does nothing but loading the native library.
boolean	onError(ResourceString location, ResourceString message) Handler called when an error occurs.

Methods inherited from class cli.Menu

execute, onExit, onPrompt, populate

Methods inherited from class cli.SyntaxNode

addElement

Methods inherited from class cli.Element

getCli, getErrorStream, getHelp, getKeyword, getOutputStream, getShell

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

Constructor Detail

Cli

public Cli(java.lang.String J_Name,
           Help CLI_Help)

Constructor.

Parameters:

J_Name - Name of the CLI.

CLI_Help - Help of the CLI.

Method Detail

load

public static void load()

Does nothing but loading the native library.

findFromName

public static final int findFromName(java.util.Collection<Cli> J_CliList,
                                     java.lang.String J_RegExp)

Find from name.

Parameters:

J_CliList - Output CLI list.

J_RegExp - Regular expression describing the CLI name searched.

Returns:

Number of CLI instances found.

getName

public final java.lang.String getName()

Name accessor.

Overrides:

getName in class Menu

Returns:

CLI name.

addMenu

public final Menu addMenu(Menu CLI_Menu)

Menu addition.

Parameters:

CLI_Menu - Menu to add to the CLI.

Returns:

The menu itself.

getMenu

public final Menu getMenu(java.lang.String J_MenuName)

Menu retrieval.

Parameters:

J_MenuName - Menu name.

Returns:

The menu identified by the given name, null if not found.

addCommentLinePattern

public final boolean addCommentLinePattern(java.lang.String J_Start)

Comment line pattern addition.

Parameters:

J_Start - Comment line starter pattern.

Returns:

true if the comment line pattern has been successfully added, false otherwise.

onError

public boolean onError(ResourceString location,
                       ResourceString message)

Handler called when an error occurs. This method may be overridden by final menu classes.

Parameters:

location - Location of the error.

message - Message of the error.

Returns:

true if the error can be displayed by the shell, false if it should not be displayed.

isConfigMenuEnabled

public boolean isConfigMenuEnabled()

Determines whether the configuration menu is currently enabled.

Returns:

true when the configuration menu is curently enabled, false otherwise.

enableConfigMenu

public final void enableConfigMenu(boolean B_Enable)

Configuration menu enabling.

Parameters:

B_Enable - Enable or disable the configuration menu.