A B C D E F G H I J K L M N O P Q R S T U V W Y

A

addCommentLinePattern(String) - Method in class cli.Cli

Comment line pattern addition.

addDevice(IODevice.Interface) - Method in class cli.IOMux

Device addition in the list.

addElement(Element) - Method in class cli.SyntaxNode

Adds a next element in the command lines decision tree after this node.

addHelp(int, String) - Method in class cli.Help

Help addition for a given language.

addMenu(Menu) - Method in class cli.Cli

Menu addition.

ALL_STREAMS - Static variable in class cli.ExecutionContext

All streams constant.

ALL_STREAMS - Static variable in class cli.Shell

All streams constant.

AMPERCENT - Static variable in class cli.OutputDevice

AROBASE - Static variable in class cli.OutputDevice

B

BACK_QUOTE - Static variable in class cli.OutputDevice

BACKSLASH - Static variable in class cli.OutputDevice

BACKSPACE - Static variable in class cli.OutputDevice

Backspace (changed from '\b' to 8 in version 2.7 for ASCII compliance).

beep() - Method in interface cli.OutputDevice.Interface

Makes the output device beep.

beep() - Method in class cli.OutputDevice.Java

beep() - Method in class cli.OutputDevice.Native

begin(String) - Static method in class cli.NativeTraces

Traces the entrance within a method.

BREAK - Static variable in class cli.OutputDevice

Break (Ctrl+C).

C

Choice - Class in cli.ui

Choice user interface class.

Choice(int, Collection<ResourceString>) - Constructor for class cli.ui.Choice

Top execution context constructor.

Choice(ExecutionContext.Interface, int, Collection<ResourceString>) - Constructor for class cli.ui.Choice

Child execution context constructor.

Choice(long) - Constructor for class cli.ui.Choice

Contructor for derived classes only.

CLASS - Static variable in class cli.NativeTraces

Native traces.

cleanScreen() - Method in interface cli.OutputDevice.Interface

Cleans the screen.

cleanScreen() - Method in class cli.OutputDevice.Java

cleanScreen() - Method in class cli.OutputDevice.Native

cleanScreen(boolean) - Method in class cli.Shell

Cleans the screen.

cli - package cli

Main namespace of the CLI library.

Cli - Class in cli

Command Line Interface class.

Cli(String, Help) - Constructor for class cli.Cli

Constructor.

cli.ui - package cli.ui

Additional user-interface tools.

closeDevice() - Method in interface cli.OutputDevice.Interface

Device closure handler.

closeDevice() - Method in class cli.OutputDevice.Java

closeDevice() - Method in class cli.OutputDevice.Native

CLOSING_BRACE - Static variable in class cli.OutputDevice

CLOSING_BRACKET - Static variable in class cli.OutputDevice

CLOSING_CURLY_BRACE - Static variable in class cli.OutputDevice

CLS - Static variable in class cli.OutputDevice

Clean screen key (changed from 129 to 501 in order to avoid overlap with printable ASCII characters).

COLUMN - Static variable in class cli.OutputDevice

COMA - Static variable in class cli.OutputDevice

CommandLine - Class in cli

Command line class.

CommandLine() - Constructor for class cli.CommandLine

Constructor.

Common(long) - Constructor for class cli.ExecutionContext.Common

Top and child execution context constructor.

Common(long) - Constructor for class cli.OutputDevice.Common

Constructor.

Console - Class in cli

Console input/output device.

Console() - Constructor for class cli.Console

Constructor.

COPY - Static variable in class cli.OutputDevice

Copy.

copy(OutputDevice.ScreenInfo) - Method in class cli.OutputDevice.ScreenInfo

Assignment method.

COPYRIGHT - Static variable in class cli.OutputDevice

Based on utf-8 encoding for '©'

copyValue(Param) - Method in class cli.Param

Copy value method.

createdFromNative(NativeObject) - Static method in class cli.NativeObject

To be called by native created objects.

createFromNative(long) - Static method in class cli.Help

Creation from native code.

createFromNative(long) - Static method in class cli.OutputDevice.ScreenInfo

Creation from native code.

createFromNative(long) - Static method in class cli.ParamFloat

Creation from native code.

createFromNative(long) - Static method in class cli.ParamHost

Creation from native code.

createFromNative(long) - Static method in class cli.ParamInt

Creation from native code.

createFromNative(long) - Static method in class cli.ParamString

Creation from native code.

createFromNative(long) - Static method in class cli.ResourceString

Creation from native code.

CUT - Static variable in class cli.OutputDevice

Cut.

D

DEFAULT_HEIGHT - Static variable in class cli.OutputDevice.ScreenInfo

Default height constant.

DEFAULT_WIDTH - Static variable in class cli.OutputDevice.ScreenInfo

Default width constant.

DEGREE - Static variable in class cli.OutputDevice

Based on utf-8 encoding for '°'

DELETE - Static variable in class cli.OutputDevice

Delete key (changed from 128 to 127 in version 2.7 for ASCII compliance).

displayHelp() - Method in class cli.Shell

Displays help depending on the context of the current line.

DOLLAR - Static variable in class cli.OutputDevice

dontFinalize() - Method in class cli.NativeObject

Call this method for Java objects which native objects should not be destroyed from Java code on finalization.

DOT - Static variable in class cli.OutputDevice

DOUBLE_QUOTE - Static variable in class cli.OutputDevice

E

ECHO_STREAM - Static variable in class cli.ExecutionContext

Echo stream constant.

ECHO_STREAM - Static variable in class cli.Shell

Echo stream constant.

Element - Class in cli

CLI element class.

Element(long) - Constructor for class cli.Element

Constructor.

enableConfigMenu(boolean) - Method in class cli.Cli

Configuration menu enabling.

enableSpecialCharacters(boolean) - Method in class cli.InputFileDevice

Special characters enabling.

enableStream(int, boolean) - Method in class cli.ExecutionContext.Common

enableStream(int, boolean) - Method in interface cli.ExecutionContext.Interface

Enabling/disabling output streams.

end(String) - Static method in class cli.NativeTraces

Traces the output of a void method.

end(String, String) - Static method in class cli.NativeTraces

Traces the output of a method returning a value.

Endl - Class in cli

End of line element.

Endl(Help) - Constructor for class cli.Endl

Constructor.

endl() - Method in class cli.OutputDevice.Common

endl() - Method in interface cli.OutputDevice.Interface

Pushes an end of line to be displayed by the output device.

ENTER - Static variable in class cli.OutputDevice

Enter.

enterMenu(Menu, boolean) - Method in class cli.Shell

Enter a menu.

EQUAL - Static variable in class cli.OutputDevice

ERROR_STREAM - Static variable in class cli.ExecutionContext

Error stream constant.

ERROR_STREAM - Static variable in class cli.Shell

Error stream constant.

ESCAPE - Static variable in class cli.OutputDevice

Escape.

EURO - Static variable in class cli.OutputDevice

Based on utf-8 encoding for '€'

EXCLAMATION - Static variable in class cli.OutputDevice

execute(CommandLine) - Method in class cli.Menu

Command line execution.

ExecutionContext - Class in cli

Execution context.

ExecutionContext() - Constructor for class cli.ExecutionContext

ExecutionContext.Common - Class in cli

Common behaviours of non-blocking input/output devices, whatever their location of implementation.

ExecutionContext.Interface - Interface in cli

Generic execution context interface.

ExecutionContext.Java - Class in cli

Java-implemented execution contexts.

ExecutionContext.Native - Class in cli

Native-implemented execution contexts.

ExecutionResult - Class in cli

Result interface for execution contexts.

ExecutionResult() - Constructor for class cli.ExecutionResult

Default constructor.

exitMenu(boolean) - Method in class cli.Shell

Exits the current menu.

F

F1 - Static variable in class cli.OutputDevice

F10 - Static variable in class cli.OutputDevice

F11 - Static variable in class cli.OutputDevice

F12 - Static variable in class cli.OutputDevice

F2 - Static variable in class cli.OutputDevice

F3 - Static variable in class cli.OutputDevice

F4 - Static variable in class cli.OutputDevice

F5 - Static variable in class cli.OutputDevice

F6 - Static variable in class cli.OutputDevice

F7 - Static variable in class cli.OutputDevice

F8 - Static variable in class cli.OutputDevice

F9 - Static variable in class cli.OutputDevice

finalize() - Method in class cli.NativeObject

Destructor.

findFromName(Collection<Cli>, String) - Static method in class cli.Cli

Find from name.

Float - Class in cli.ui

Float user interface class.

Float(double, double, double) - Constructor for class cli.ui.Float

Top execution context constructor.

Float(ExecutionContext.Interface, double, double, double) - Constructor for class cli.ui.Float

Child execution context constructor.

forget(NativeObject) - Static method in class cli.NativeObject

Java instances to be forgotten (native object can now be destroyed) should be dereferenced with this method.

G

getbDoFinalize() - Method in class cli.NativeObject

Accessor to be used in order to know whether the native instance instance should be destroyed or not.

getBeep() - Method in class cli.ExecutionContext.Common

getBeep() - Method in interface cli.ExecutionContext.Interface

Beep configuration access.

getbExecResult() - Method in class cli.ui.UI

Execution result accessor.

getbTrueCls() - Method in class cli.OutputDevice.ScreenInfo

True cleanScreen() characteristic accessor.

getbWrapLines() - Method in class cli.OutputDevice.ScreenInfo

Lines wrapping characteristic accessor.

getChoice() - Method in class cli.ui.Choice

Choice retrieval.

getClassName() - Method in class cli.TraceClass

Class name accessor.

getCli() - Method in class cli.Element

Owner CLI accessor.

getCli() - Method in class cli.Shell

Cli accessor.

getCloned() - Method in class cli.Param

Source clone parameter accessor.

getCurrentDevice() - Method in class cli.IOMux

Current device accessor.

getCurrentMenu(int) - Method in class cli.Shell

Current menu retrieval.

getErrorStream() - Method in class cli.Element

Current error stream accessor.

getExecutionContext() - Method in class cli.NonBlockingIODevice.Java

Returns the current execution context.

getExecutionContext() - Method in class cli.NonBlockingIODevice.Native

Returns the current execution context.

getFloat() - Method in class cli.ui.Float

Float retrieval.

getHeight() - Method in class cli.OutputDevice.ScreenInfo

Screen height accessor.

getHelp() - Method in class cli.Element

Element help accessor.

getHelp(int) - Method in class cli.Help

Retrieves help resource for the given language.

getHelp() - Method in class cli.TraceClass

Help object accessor.

getHelp(int) - Method in class cli.TraceClass

Direct help string accessor.

getHelpMargin() - Method in class cli.Shell

Help margin accessor.

getHelpOffset() - Method in class cli.Shell

Help offset accessor.

getInput() - Method in class cli.ExecutionContext.Common

getInput() - Method in interface cli.ExecutionContext.Interface

Input stream accessor.

getInt() - Method in class cli.ui.Int

Integer retrieval.

getJniTraceClass() - Static method in class cli.TraceClass

Native JNI trace class singleton.

getKey() - Method in interface cli.IODevice.Interface

Input key capture.

getKey() - Method in class cli.IODevice.Java

getKey() - Method in class cli.IODevice.Native

getKey() - Method in class cli.NonBlockingIODevice.Java

getKeyword() - Method in class cli.Element

Element name accessor.

getLang() - Method in class cli.ExecutionContext.Common

getLang() - Method in interface cli.ExecutionContext.Interface

Language access.

getLine() - Method in class cli.ui.Line

Line retrieval.

getLocation() - Method in interface cli.IODevice.Interface

Location accessor.

getLocation() - Method in class cli.IODevice.Java

getLocation() - Method in class cli.IODevice.Native

getMenu(String) - Method in class cli.Cli

Menu retrieval.

getName() - Method in class cli.Cli

Name accessor.

getName() - Method in class cli.Menu

Menu name access.

getNativeRef() - Method in interface cli.ExecutionContext.Interface

Native object interface compliance.

getNativeRef() - Method in class cli.NativeObject

Native reference accessor.

getNativeRef() - Method in interface cli.OutputDevice.Interface

Native object interface compliance.

getNullDevice() - Static method in class cli.IODevice

Null device singleton.

getNullDevice() - Static method in class cli.OutputDevice

Null device singleton.

getObject(long) - Static method in class cli.NativeObject

Find the Java instance from its native instance reference.

getOutputStream() - Method in class cli.Element

Current output stream accessor.

getPassword() - Method in class cli.ui.Password

Password retrieval.

getSafeHeight() - Method in class cli.OutputDevice.ScreenInfo

Safe screen height accessor.

getSafeWidth() - Method in class cli.OutputDevice.ScreenInfo

Safe screen width accessor.

getScreenInfo() - Method in interface cli.OutputDevice.Interface

Screen info accessor.

getScreenInfo() - Method in class cli.OutputDevice.Java

getScreenInfo() - Method in class cli.OutputDevice.Native

getShell() - Method in class cli.Element

Running shell accessor.

getStdErr() - Static method in class cli.OutputDevice

Standard error device singleton.

getStdIn() - Static method in class cli.IODevice

Standard input device singleton.

getStdOut() - Static method in class cli.OutputDevice

Standard output device singleton.

getstrChoice() - Method in class cli.ui.Choice

Choice retrieval in its string form.

getStream(int) - Method in class cli.ExecutionContext.Common

getStream(int) - Method in interface cli.ExecutionContext.Interface

Output stream accessor.

getStream() - Static method in class cli.Traces

Traces output stream accessor.

getString(int) - Method in class cli.ResourceString

Retrieves the string attached for the given language.

getString() - Method in class cli.StringDevice

String accessor.

getText() - Method in class cli.ui.Less

Inner device accessor.

getText() - Method in class cli.ui.More

Inner device accessor.

getValue() - Method in class cli.ParamFloat

Double value accessor.

getValue() - Method in class cli.ParamHost

Host value accessor.

getValue() - Method in class cli.ParamInt

Integer value accessor.

getValue() - Method in class cli.ParamString

String value accessor.

getWidth() - Method in class cli.OutputDevice.ScreenInfo

Screen width accessor.

getYesNo() - Method in class cli.ui.YesNo

Yes/No answer retrieval.

GREATER_THAN - Static variable in class cli.OutputDevice

H

hasHelp(int) - Method in class cli.Help

States whether the help object has a help resource for the given language.

hasString(int) - Method in class cli.ResourceString

States whether the resource string object has a resource for the given language.

Help - Class in cli

Help class.

Help() - Constructor for class cli.Help

Default constructor.

Help(Help) - Constructor for class cli.Help

Copy constructor.

I

InputFileDevice - Class in cli

Input file device.

InputFileDevice(String, OutputDevice.Interface) - Constructor for class cli.InputFileDevice

Constructor.

INSERT - Static variable in class cli.OutputDevice

Insert key (changed from 500 to 502 in order to avoid overlap with printable ASCII characters).

Int - Class in cli.ui

Integer user interface object.

Int(int, int, int) - Constructor for class cli.ui.Int

Top execution context constructor.

Int(ExecutionContext.Interface, int, int, int) - Constructor for class cli.ui.Int

Child execution context constructor.

IODevice - Class in cli

Input/output device management.

IODevice() - Constructor for class cli.IODevice

IODevice.Interface - Interface in cli

Generic input/output device interface.

IODevice.Java - Class in cli

Java-implemented input/output devices.

IODevice.Native - Class in cli

Native-implemented input/output devices.

IOMux - Class in cli

Input/output device multiplexer.

IOMux() - Constructor for class cli.IOMux

Default constructor.

isConfigMenuEnabled() - Method in class cli.Cli

Determines whether the configuration menu is currently enabled.

isRunning() - Method in class cli.ExecutionContext.Common

isRunning() - Method in interface cli.ExecutionContext.Interface

Tells whether this execution context is running or not.

iterator() - Method in class cli.CommandLine

Retrieves an iterator over the elements of the command line.

J

Java() - Constructor for class cli.ExecutionContext.Java

Top execution context constructor.

Java(ExecutionContext.Interface) - Constructor for class cli.ExecutionContext.Java

Top and child execution context constructor.

Java(String) - Constructor for class cli.IODevice.Java

Constructor.

Java(long) - Constructor for class cli.IODevice.Java

Constructor for NonBlockingIODevice classes only.

Java(String) - Constructor for class cli.NonBlockingIODevice.Java

Constructor.

Java(String) - Constructor for class cli.OutputDevice.Java

Constructor.

Java(long) - Constructor for class cli.OutputDevice.Java

Constructor for IODevice.Java classes only.

K

KEY_0 - Static variable in class cli.OutputDevice

KEY_1 - Static variable in class cli.OutputDevice

KEY_2 - Static variable in class cli.OutputDevice

KEY_3 - Static variable in class cli.OutputDevice

KEY_4 - Static variable in class cli.OutputDevice

KEY_5 - Static variable in class cli.OutputDevice

KEY_6 - Static variable in class cli.OutputDevice

KEY_7 - Static variable in class cli.OutputDevice

KEY_8 - Static variable in class cli.OutputDevice

KEY_9 - Static variable in class cli.OutputDevice

KEY_a - Static variable in class cli.OutputDevice

KEY_A - Static variable in class cli.OutputDevice

KEY_aacute - Static variable in class cli.OutputDevice

Based on utf-8 encoding for 'á'

KEY_acirc - Static variable in class cli.OutputDevice

Based on utf-8 encoding for 'â'

KEY_agrave - Static variable in class cli.OutputDevice

Based on utf-8 encoding for 'à'

KEY_auml - Static variable in class cli.OutputDevice

Based on utf-8 encoding for 'ä'

KEY_b - Static variable in class cli.OutputDevice

KEY_B - Static variable in class cli.OutputDevice

KEY_BEGIN - Static variable in class cli.OutputDevice

Begin key.

KEY_c - Static variable in class cli.OutputDevice

KEY_C - Static variable in class cli.OutputDevice

KEY_ccedil - Static variable in class cli.OutputDevice

Based on utf-8 encoding for 'ç'

KEY_d - Static variable in class cli.OutputDevice

KEY_D - Static variable in class cli.OutputDevice

KEY_DOWN - Static variable in class cli.OutputDevice

Down arrow key.

KEY_e - Static variable in class cli.OutputDevice

KEY_E - Static variable in class cli.OutputDevice

KEY_eacute - Static variable in class cli.OutputDevice

Based on utf-8 encoding for 'é'

KEY_ecirc - Static variable in class cli.OutputDevice

Based on utf-8 encoding for 'ê'

KEY_egrave - Static variable in class cli.OutputDevice

Based on utf-8 encoding for 'è'

KEY_END - Static variable in class cli.OutputDevice

End key.

KEY_euml - Static variable in class cli.OutputDevice

Based on utf-8 encoding for 'ë'

KEY_f - Static variable in class cli.OutputDevice

KEY_F - Static variable in class cli.OutputDevice

KEY_g - Static variable in class cli.OutputDevice

KEY_G - Static variable in class cli.OutputDevice

KEY_h - Static variable in class cli.OutputDevice

KEY_H - Static variable in class cli.OutputDevice

KEY_i - Static variable in class cli.OutputDevice

KEY_I - Static variable in class cli.OutputDevice

KEY_iacute - Static variable in class cli.OutputDevice

Based on utf-8 encoding for 'í'

KEY_icirc - Static variable in class cli.OutputDevice

Based on utf-8 encoding for 'î'

KEY_igrave - Static variable in class cli.OutputDevice

Based on utf-8 encoding for 'ì'

KEY_iuml - Static variable in class cli.OutputDevice

Based on utf-8 encoding for 'ï'

KEY_j - Static variable in class cli.OutputDevice

KEY_J - Static variable in class cli.OutputDevice

KEY_k - Static variable in class cli.OutputDevice

KEY_K - Static variable in class cli.OutputDevice

KEY_l - Static variable in class cli.OutputDevice

KEY_L - Static variable in class cli.OutputDevice

KEY_LEFT - Static variable in class cli.OutputDevice

Left arrow key.

KEY_m - Static variable in class cli.OutputDevice

KEY_M - Static variable in class cli.OutputDevice

KEY_n - Static variable in class cli.OutputDevice

KEY_N - Static variable in class cli.OutputDevice

KEY_o - Static variable in class cli.OutputDevice

KEY_O - Static variable in class cli.OutputDevice

KEY_oacute - Static variable in class cli.OutputDevice

Based on utf-8 encoding for 'ó'

KEY_ocirc - Static variable in class cli.OutputDevice

Based on utf-8 encoding for 'ô'

KEY_ograve - Static variable in class cli.OutputDevice

Based on utf-8 encoding for 'ò'

KEY_ouml - Static variable in class cli.OutputDevice

Based on utf-8 encoding for 'ö'

KEY_p - Static variable in class cli.OutputDevice

KEY_P - Static variable in class cli.OutputDevice

KEY_q - Static variable in class cli.OutputDevice

KEY_Q - Static variable in class cli.OutputDevice

KEY_r - Static variable in class cli.OutputDevice

KEY_R - Static variable in class cli.OutputDevice

KEY_RIGHT - Static variable in class cli.OutputDevice

Right arrow key.

KEY_s - Static variable in class cli.OutputDevice

KEY_S - Static variable in class cli.OutputDevice

KEY_t - Static variable in class cli.OutputDevice

KEY_T - Static variable in class cli.OutputDevice

KEY_u - Static variable in class cli.OutputDevice

KEY_U - Static variable in class cli.OutputDevice

KEY_uacute - Static variable in class cli.OutputDevice

Based on utf-8 encoding for 'ú'

KEY_ucirc - Static variable in class cli.OutputDevice

Based on utf-8 encoding for 'û'

KEY_ugrave - Static variable in class cli.OutputDevice

Based on utf-8 encoding for 'ù'

KEY_UP - Static variable in class cli.OutputDevice

Up arrow key.

KEY_uuml - Static variable in class cli.OutputDevice

Based on utf-8 encoding for 'ü'

KEY_v - Static variable in class cli.OutputDevice

KEY_V - Static variable in class cli.OutputDevice

KEY_w - Static variable in class cli.OutputDevice

KEY_W - Static variable in class cli.OutputDevice

KEY_x - Static variable in class cli.OutputDevice

KEY_X - Static variable in class cli.OutputDevice

KEY_y - Static variable in class cli.OutputDevice

KEY_Y - Static variable in class cli.OutputDevice

KEY_z - Static variable in class cli.OutputDevice

KEY_Z - Static variable in class cli.OutputDevice

Keyword - Class in cli

Keyword element class.

Keyword(String, Help) - Constructor for class cli.Keyword

Constructor.

L

LANG_COUNT - Static variable in class cli.ResourceString

Number of languages managed by the library.

LANG_EN - Static variable in class cli.ResourceString

English language constant.

LANG_FR - Static variable in class cli.ResourceString

French language constant.

Less - Class in cli.ui

'less' display object.

Less() - Constructor for class cli.ui.Less

Top execution context constructor.

Less(ExecutionContext.Interface) - Constructor for class cli.ui.Less

Child execution context constructor.

Line - Class in cli.ui

Simple line user interface object.

Line(String, int, int) - Constructor for class cli.ui.Line

Top execution context constructor.

Line(ExecutionContext.Interface, String, int, int) - Constructor for class cli.ui.Line

Child execution context constructor.

Line(long) - Constructor for class cli.ui.Line

Contructor for derived classes only.

load() - Static method in class cli.Cli

Does nothing but loading the native library.

LOGOUT - Static variable in class cli.OutputDevice

Logout (Ctrl+D).

LOWER_THAN - Static variable in class cli.OutputDevice

M

matches(Element) - Method in class cli.Param

Determines whether an element matches this parameter.

Menu - Class in cli

Menu class.

Menu(long) - Constructor for class cli.Menu

Constructor from native instance.

Menu(String, Help) - Constructor for class cli.Menu

Constructor from Java.

MenuRef - Class in cli

Menu reference element class.

MenuRef(Menu) - Constructor for class cli.MenuRef

Constructor.

MICRO - Static variable in class cli.OutputDevice

Based on utf-8 encoding for 'µ'

MINUS - Static variable in class cli.OutputDevice

More - Class in cli.ui

'more' display object.

More() - Constructor for class cli.ui.More

Top execution context constructor.

More(ExecutionContext.Interface) - Constructor for class cli.ui.More

Child execution context constructor.

N

Native(long) - Constructor for class cli.ExecutionContext.Native

Top and child execution context constructor.

Native(long) - Constructor for class cli.IODevice.Native

Constructor.

Native(long) - Constructor for class cli.NonBlockingIODevice.Native

Constructor.

Native(long) - Constructor for class cli.OutputDevice.Native

Constructor.

NativeObject - Class in cli

Java object corresponding to a native object class.

NativeObject(long) - Constructor for class cli.NativeObject

Constructor.

NativeTraces - Class in cli

Tool class for native traces.

NativeTraces() - Constructor for class cli.NativeTraces

NEXT - Static variable in class cli.OutputDevice

Forward key.

NonBlockingIODevice - Class in cli

Non-blocking input device.

NonBlockingIODevice() - Constructor for class cli.NonBlockingIODevice

NonBlockingIODevice.Interface - Interface in cli

Generic input/output device interface.

NonBlockingIODevice.Java - Class in cli

Java-implemented non blocking input/output devices.

NonBlockingIODevice.Native - Class in cli

Native-implemented input/output devices.

NULL_KEY - Static variable in class cli.OutputDevice

Null key.

O

onCloseConnection(TelnetConnection, ExecutionContext.Interface) - Method in class cli.TelnetServer

Execution context release handler.

onError(ResourceString, ResourceString) - Method in class cli.Cli

Handler called when an error occurs.

onExit() - Method in class cli.Menu

Handler called when the menu exits.

onKey(int) - Method in class cli.ExecutionContext.Java

Handler called on character input.

onKey(int) - Method in interface cli.NonBlockingIODevice.Interface

Handler to call when a key is received.

onKey(int) - Method in class cli.NonBlockingIODevice.Java

onKey(int) - Method in class cli.NonBlockingIODevice.Native

onNewConnection(TelnetConnection) - Method in class cli.TelnetServer

onPrompt() - Method in class cli.Menu

Handler called when then menu displays its prompt.

onResult(ExecutionContext.Interface) - Method in class cli.ExecutionResult

User interface result handler.

onStartExecution() - Method in class cli.ExecutionContext.Java

Beginning of execution handler.

onStopExecution() - Method in class cli.ExecutionContext.Java

Execution termination handler.

openDevice() - Method in interface cli.OutputDevice.Interface

Device opening handler.

openDevice() - Method in class cli.OutputDevice.Java

openDevice() - Method in class cli.OutputDevice.Native

OPENING_BRACE - Static variable in class cli.OutputDevice

OPENING_BRACKET - Static variable in class cli.OutputDevice

OPENING_CURLY_BRACE - Static variable in class cli.OutputDevice

OUTPUT_STREAM - Static variable in class cli.ExecutionContext

Output stream constant.

OUTPUT_STREAM - Static variable in class cli.Shell

Output stream constant.

OutputDevice - Class in cli

Output device management.

OutputDevice() - Constructor for class cli.OutputDevice

OutputDevice.Common - Class in cli

Class containing all common behaviours of output devices, whatever their location of implementation.

OutputDevice.Interface - Interface in cli

Generic output device interface.

OutputDevice.Java - Class in cli

Java-implemented output devices.

OutputDevice.Native - Class in cli

Native-implemented output devices.

OutputDevice.OutputStream - Class in cli

Java output stream attached to a CLI output device.

OutputDevice.ScreenInfo - Class in cli

Screen information.

OutputFileDevice - Class in cli

Output file device.

OutputFileDevice(String) - Constructor for class cli.OutputFileDevice

Constructor.

OutputStream(OutputDevice.Interface) - Constructor for class cli.OutputDevice.OutputStream

Constructor.

P

PAGE_DOWN - Static variable in class cli.OutputDevice

Page down arrow key.

PAGE_LEFT - Static variable in class cli.OutputDevice

Page left arrow key.

PAGE_RIGHT - Static variable in class cli.OutputDevice

Page right arrow key.

PAGE_UP - Static variable in class cli.OutputDevice

Page up arrow key.

PARAGRAPH - Static variable in class cli.OutputDevice

Based on utf-8 encoding for '§'

param(String, String) - Static method in class cli.NativeTraces

Traces a parameter value, when entering a method basically.

Param - Class in cli

Generic parameter element.

Param(long) - Constructor for class cli.Param

Constructor.

ParamFloat - Class in cli

Float parameter element.

ParamFloat(Help) - Constructor for class cli.ParamFloat

Constructor.

ParamHost - Class in cli

Host parameter element.

ParamHost(Help) - Constructor for class cli.ParamHost

Constructor.

ParamInt - Class in cli

Integer parameter element.

ParamInt(Help) - Constructor for class cli.ParamInt

Constructor.

ParamString - Class in cli

String parameter element.

ParamString(Help) - Constructor for class cli.ParamString

Constructor.

Password - Class in cli.ui

Password user interface object.

Password(boolean, int, int) - Constructor for class cli.ui.Password

Top execution context constructor.

Password(ExecutionContext.Interface, boolean, int, int) - Constructor for class cli.ui.Password

Child execution context constructor.

PASTE - Static variable in class cli.OutputDevice

Paste.

PERCENT - Static variable in class cli.OutputDevice

PIPE - Static variable in class cli.OutputDevice

PLUS - Static variable in class cli.OutputDevice

populate() - Method in class cli.Menu

Populate abstract method.

POUND - Static variable in class cli.OutputDevice

Based on utf-8 encoding for '£'

PREVIOUS - Static variable in class cli.OutputDevice

Previous key.

printStackTrace(Exception) - Method in class cli.OutputDevice.Common

printStackTrace(Exception) - Method in interface cli.OutputDevice.Interface

Exception stack trace display.

printWorkingMenu() - Method in class cli.Shell

Prints the working menu.

PROMPT_STREAM - Static variable in class cli.ExecutionContext

Prompt stream constant.

PROMPT_STREAM - Static variable in class cli.Shell

Prompt stream constant.

put(Integer) - Method in class cli.OutputDevice.Common

put(Float) - Method in class cli.OutputDevice.Common

put(Double) - Method in class cli.OutputDevice.Common

put(String) - Method in interface cli.OutputDevice.Interface

Pushes characters to the output device.

put(Integer) - Method in interface cli.OutputDevice.Interface

Pushes an integer value to be displayed by the output device.

put(Float) - Method in interface cli.OutputDevice.Interface

Pushes a float value to be displayed by the output device.

put(Double) - Method in interface cli.OutputDevice.Interface

Pushes a double value to be displayed by the output device.

put(String) - Method in class cli.OutputDevice.Java

put(String) - Method in class cli.OutputDevice.Native

Q

QUESTION - Static variable in class cli.OutputDevice

quit() - Method in class cli.Shell

Terminates the shell.

QUOTE - Static variable in class cli.OutputDevice

R

REDO - Static variable in class cli.OutputDevice

Redo.

remember(NativeObject) - Static method in class cli.NativeObject

Java instances to be remembered for native object consistency should be referenced with this method.

reset() - Method in class cli.StringDevice

Reset.

ResourceString - Class in cli

Resource string class.

ResourceString() - Constructor for class cli.ResourceString

Default constructor.

ResourceString(ResourceString) - Constructor for class cli.ResourceString

Copy constructor.

ResourceString(long) - Constructor for class cli.ResourceString

Constructor for createFromNative() or child classes only.

run(IODevice.Interface) - Method in class cli.ExecutionContext.Common

run() - Method in class cli.ExecutionContext.Common

run(IODevice.Interface) - Method in interface cli.ExecutionContext.Interface

Runs the execution context onto the corresponding input/output device.

run() - Method in interface cli.ExecutionContext.Interface

Runs the execution context as a child context of the parent given by the construction.

S

safeTrace(TraceClass, NativeObject, String) - Static method in class cli.Traces

Safe trace routine.

safeTrace(TraceClass, long, String) - Static method in class cli.Traces

Safe trace routine.

ScreenInfo(int, int, boolean, boolean) - Constructor for class cli.OutputDevice.ScreenInfo

Constructor.

ScreenInfo(long) - Constructor for class cli.OutputDevice.ScreenInfo

Constructor for createFromNative().

SEMI_COLUMN - Static variable in class cli.OutputDevice

setAllFilter(boolean) - Static method in class cli.Traces

Modifies the traces filter for all trace classes.

setBeep(boolean) - Method in class cli.ExecutionContext.Common

setBeep(boolean) - Method in interface cli.ExecutionContext.Interface

Beep configuration setting.

setByeMessage(ResourceString) - Method in class cli.Shell

Bye message setting.

setFilter(TraceClass, boolean) - Static method in class cli.Traces

Modifies the traces filter.

setLang(int) - Method in class cli.ExecutionContext.Common

setLang(int) - Method in interface cli.ExecutionContext.Interface

Language setting.

setMenuRef(MenuRef) - Method in class cli.Endl

Used when this command line gives access to a menu.

setPrompt(ResourceString) - Method in class cli.Shell

Prompt message positionning.

setStream(int, OutputDevice.Interface) - Method in class cli.ExecutionContext.Common

setStream(int, OutputDevice.Interface) - Method in interface cli.ExecutionContext.Interface

Output stream positionning.

setStream(OutputDevice.Interface) - Static method in class cli.Traces

Stream positionning (if not already set).

setString(int, String) - Method in class cli.ResourceString

String addition for a given language.

setWelcomeMessage(ResourceString) - Method in class cli.Shell

Welcome message setting.

SHARP - Static variable in class cli.OutputDevice

Shell - Class in cli

Shell class.

Shell(Cli) - Constructor for class cli.Shell

Top execution context constructor.

Shell(ExecutionContext.Interface, Cli) - Constructor for class cli.Shell

Child execution context constructor.

SingleCommand - Class in cli

Input file device.

SingleCommand(String, OutputDevice.Interface) - Constructor for class cli.SingleCommand

Constructor.

SLASH - Static variable in class cli.OutputDevice

SPACE - Static variable in class cli.OutputDevice

Space.

SQUARE - Static variable in class cli.OutputDevice

Based on utf-8 encoding for '²'

STAR - Static variable in class cli.OutputDevice

startServer() - Method in class cli.TelnetServer

Starts the server.

stopAllExecutions() - Method in class cli.ExecutionContext.Common

stopAllExecutions() - Method in interface cli.ExecutionContext.Interface

Terminates execution for all execution contexts attached to the same top execution context.

stopExecution() - Method in class cli.ExecutionContext.Common

stopExecution() - Method in interface cli.ExecutionContext.Interface

Terminates this execution context's execution.

stopServer() - Method in class cli.TelnetServer

Stops the server

STREAM_TYPES_COUNT - Static variable in class cli.ExecutionContext

Number of stream types.

STREAM_TYPES_COUNT - Static variable in class cli.Shell

Number of stream types.

streamEnabled(int) - Method in class cli.ExecutionContext.Common

streamEnabled(int) - Method in interface cli.ExecutionContext.Interface

Enabled/disabled stream status accessor.

StringDevice - Class in cli

String device.

StringDevice() - Constructor for class cli.StringDevice

Constructor.

switchNextDevice() - Method in class cli.IOMux

Switch to next device.

SyntaxNode - Class in cli

A syntax node is an element which may be considered as a node in the decision tree defining the command lines.

SyntaxNode(long) - Constructor for class cli.SyntaxNode

Constructor.

SyntaxRef - Class in cli

A syntax reference is an element which references a syntax tag.

SyntaxRef(SyntaxTag) - Constructor for class cli.SyntaxRef

Constructor.

SyntaxTag - Class in cli

A syntax tag does nothing from the execution point of view, and represents no keyword nor parameter.

SyntaxTag(boolean) - Constructor for class cli.SyntaxTag

Regular constructor.

T

TAB - Static variable in class cli.OutputDevice

TelnetConnection - Class in cli

TelnetServer - Class in cli

Telnet server class.

TelnetServer(int, int, int) - Constructor for class cli.TelnetServer

Constructor.

TILDE - Static variable in class cli.OutputDevice

trace(TraceClass, String) - Static method in class cli.Traces

Sends a trace to the trace system.

TraceClass - Class in cli

Trace class description.

TraceClass(TraceClass) - Constructor for class cli.TraceClass

Copy constructor.

TraceClass(String, Help) - Constructor for class cli.TraceClass

Constructor with a trace class name and a corresponding help given.

Traces - Class in cli

Traces management class.

U

UI - Class in cli.ui

Generic user interface class.

UI(long) - Constructor for class cli.ui.UI

Default constructor.

UNDERSCORE - Static variable in class cli.OutputDevice

UNDO - Static variable in class cli.OutputDevice

Undo.

UNKNOWN - Static variable in class cli.OutputDevice.ScreenInfo

Unknown value constant for either width or height.

unsetStream(OutputDevice.Interface) - Static method in class cli.Traces

Restores the initial traces output stream.

V

value(String, String) - Static method in class cli.NativeTraces

Traces a variable value, within the body of a method basically.

W

watchResult(ExecutionResult) - Method in class cli.ExecutionContext.Common

watchResult(ExecutionResult) - Method in interface cli.ExecutionContext.Interface

Context execution result interface registration.

watchResult(ExecutionContext.Interface) - Method in class cli.ExecutionResult

Context execution result interface registration.

WELCOME_STREAM - Static variable in class cli.ExecutionContext

Welcome stream constant.

WELCOME_STREAM - Static variable in class cli.Shell

Welcome stream constant.

wouldInput(IODevice.Interface) - Method in interface cli.IODevice.Interface

Stack overflow protection.

wouldInput(IODevice.Interface) - Method in class cli.IODevice.Java

wouldInput(IODevice.Interface) - Method in class cli.IODevice.Native

wouldOutput(OutputDevice.Interface) - Method in interface cli.OutputDevice.Interface

Stack overflow protection.

wouldOutput(OutputDevice.Interface) - Method in class cli.OutputDevice.Java

wouldOutput(OutputDevice.Interface) - Method in class cli.OutputDevice.Native

write(int) - Method in class cli.OutputDevice.OutputStream

Output handler.

Y

YesNo - Class in cli.ui

Yes/No question user interface object.

YesNo(boolean) - Constructor for class cli.ui.YesNo

Top execution context constructor.

YesNo(ExecutionContext.Interface, boolean) - Constructor for class cli.ui.YesNo

Child execution context constructor.

A B C D E F G H I J K L M N O P Q R S T U V W Y