cli

Class Menu

java.lang.Object

cli.NativeObject

cli.Element

cli.SyntaxNode

cli.Menu

Direct Known Subclasses:

Cli

public abstract class Menu
extends SyntaxNode

Menu class. A menu owns Element instances, which owns next Element instances... terminated by an Endl instance. Command lines are defined this way. When the shell analyzes a command line, it asks the corresponding menu to execute it through the abstract execute() method. The menu class also offers a handler to execute special operations when the menu exits.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Menu(long I64_NativeRef) Constructor from native instance.
	Menu(java.lang.String J_Name, Help CLI_Help) Constructor from Java.

Method Summary

Modifier and Type	Method and Description
abstract boolean	execute(CommandLine CLI_CmdLine) Command line execution.
java.lang.String	getName() Menu name access.
void	onExit() Handler called when the menu exits.
java.lang.String	onPrompt() Handler called when then menu displays its prompt.
abstract void	populate() Populate abstract method.

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

Menu

protected Menu(long I64_NativeRef)

Constructor from native instance.

Parameters:

I64_NativeRef - Native instance reference.

Menu

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

Constructor from Java.

Parameters:

J_Name - Name of the menu.

CLI_Help - Help attached to the menu.

Method Detail

getName

public java.lang.String getName()

Menu name access.

Returns:

Name of the menu.

populate

public abstract void populate()

Populate abstract method. This method should be overridden by final menu classes to describe the elements defining the command lines attached to the menu.

execute

public abstract boolean execute(CommandLine CLI_CmdLine)

Command line execution. This method should be overridden by final menu classes.

Parameters:

CLI_CmdLine - Command line to execute.

Returns:

true if the command line has been executed successfully (syntactically speaking), false otherwise.

onExit

public void onExit()

Handler called when the menu exits. This method may be overridden by final menu classes.

onPrompt

public java.lang.String onPrompt()

Handler called when then menu displays its prompt.

Returns:

The prompt to display. An empty string for the default prompt.