cli

Interface ExecutionContext.Interface

All Known Implementing Classes:

Choice, ExecutionContext.Common, ExecutionContext.Java, ExecutionContext.Native, Float, Int, Less, Line, More, Password, Shell, UI, YesNo

Enclosing class:

ExecutionContext

public static interface ExecutionContext.Interface

Generic execution context interface.

Method Summary

Modifier and Type	Method and Description
boolean	enableStream(int E_StreamType, boolean B_Enable) Enabling/disabling output streams.
boolean	getBeep() Beep configuration access.
IODevice.Interface	getInput() Input stream accessor.
int	getLang() Language access.
long	getNativeRef() Native object interface compliance.
OutputDevice.Interface	getStream(int E_StreamType) Output stream accessor.
boolean	isRunning() Tells whether this execution context is running or not.
boolean	run() Runs the execution context as a child context of the parent given by the construction.
boolean	run(IODevice.Interface CLI_IODevice) Runs the execution context onto the corresponding input/output device.
void	setBeep(boolean B_Enable) Beep configuration setting.
void	setLang(int E_Lang) Language setting.
boolean	setStream(int E_StreamType, OutputDevice.Interface CLI_Stream) Output stream positionning.
void	stopAllExecutions() Terminates execution for all execution contexts attached to the same top execution context.
void	stopExecution() Terminates this execution context's execution.
boolean	streamEnabled(int E_StreamType) Enabled/disabled stream status accessor.
void	watchResult(ExecutionResult CLI_Result) Context execution result interface registration.

Method Detail

getInput

IODevice.Interface getInput()

Input stream accessor.

Returns:

The input stream attached to the context for its execution.

getStream

OutputDevice.Interface getStream(int E_StreamType)

Output stream accessor.

Parameters:

E_StreamType - Output stream identifier.

Returns:

The required stream. null if an error occurred.

setStream

boolean setStream(int E_StreamType,
                  OutputDevice.Interface CLI_Stream)

Output stream positionning.

Parameters:

E_StreamType - Output stream identifier.

CLI_Stream - Stream reference.

Returns:

true: success, false: failure.

streamEnabled

boolean streamEnabled(int E_StreamType)

Enabled/disabled stream status accessor.

Parameters:

E_StreamType - Output stream identifier.

Returns:

true: the stream is enabled, false: the stream is disabled.

enableStream

boolean enableStream(int E_StreamType,
                     boolean B_Enable)

Enabling/disabling output streams.

Parameters:

E_StreamType - Output stream identifier.

B_Enable - Enable flag.

Returns:

true: success, false: failure.

setLang

void setLang(int E_Lang)

Language setting.

Parameters:

E_Lang - New value.

getLang

int getLang()

Language access.

Returns:

The language currently set.

setBeep

void setBeep(boolean B_Enable)

Beep configuration setting.

Parameters:

B_Enable - New value.

getBeep

boolean getBeep()

Beep configuration access.

Returns:

The current beep configuration. true if enabled, false otherwise.

watchResult

void watchResult(ExecutionResult CLI_Result)

Context execution result interface registration. Note: Registration for each interface is discarded as soon as the end of execution is notified.

Parameters:

CLI_Result - Execution context to be watched.

run

boolean run(IODevice.Interface CLI_IODevice)

Runs the execution context onto the corresponding input/output device. Call this runner method, for top execution contexts.

Parameters:

CLI_IODevice - Input/output device to run onto.

Returns:

true: success, false: failure.

run

boolean run()

Runs the execution context as a child context of the parent given by the construction. Call this runner method, for child execution contexts.

Returns:

true: success, false: failure.

isRunning

boolean isRunning()

Tells whether this execution context is running or not.

Returns:

The running status.

stopExecution

void stopExecution()

Terminates this execution context's execution. Warning: Not thread safe. Implement a non blocking device if your CLI execution should interact with external events.

stopAllExecutions

void stopAllExecutions()

Terminates execution for all execution contexts attached to the same top execution context. Warning: Not thread safe. Implement a non blocking device if your CLI execution should interact with external events.

getNativeRef

long getNativeRef()

Native object interface compliance.

Returns:

The native reference of the instance.