cli

Class ExecutionContext.Common

java.lang.Object

cli.NativeObject

cli.ExecutionContext.Common

All Implemented Interfaces:

ExecutionContext.Interface

Direct Known Subclasses:

ExecutionContext.Native

Enclosing class:

ExecutionContext

public abstract static class ExecutionContext.Common
extends NativeObject
implements ExecutionContext.Interface

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Common(long I64_NativeRef) Top and child execution context constructor.

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.
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.

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

Methods inherited from interface cli.ExecutionContext.Interface

getNativeRef

Constructor Detail

Common

protected Common(long I64_NativeRef)

Top and child execution context constructor.

Parameters:

I64_NativeRef - Native instance reference corresponding to this Java instance.

Method Detail

getInput

public final IODevice.Interface getInput()

Description copied from interface: ExecutionContext.Interface

Input stream accessor.

Specified by:

getInput in interface ExecutionContext.Interface

Returns:

The input stream attached to the context for its execution.

getStream

public final OutputDevice.Interface getStream(int E_StreamType)

Description copied from interface: ExecutionContext.Interface

Output stream accessor.

Specified by:

getStream in interface ExecutionContext.Interface

Parameters:

E_StreamType - Output stream identifier.

Returns:

The required stream. null if an error occurred.

setStream

public final boolean setStream(int E_StreamType,
                               OutputDevice.Interface CLI_Stream)

Description copied from interface: ExecutionContext.Interface

Output stream positionning.

Specified by:

setStream in interface ExecutionContext.Interface

Parameters:

E_StreamType - Output stream identifier.

CLI_Stream - Stream reference.

Returns:

true: success, false: failure.

streamEnabled

public final boolean streamEnabled(int E_StreamType)

Description copied from interface: ExecutionContext.Interface

Enabled/disabled stream status accessor.

Specified by:

streamEnabled in interface ExecutionContext.Interface

Parameters:

E_StreamType - Output stream identifier.

Returns:

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

enableStream

public final boolean enableStream(int E_StreamType,
                                  boolean B_Enable)

Description copied from interface: ExecutionContext.Interface

Enabling/disabling output streams.

Specified by:

enableStream in interface ExecutionContext.Interface

Parameters:

E_StreamType - Output stream identifier.

B_Enable - Enable flag.

Returns:

true: success, false: failure.

setLang

public final void setLang(int E_Lang)

Description copied from interface: ExecutionContext.Interface

Language setting.

Specified by:

setLang in interface ExecutionContext.Interface

Parameters:

E_Lang - New value.

getLang

public final int getLang()

Description copied from interface: ExecutionContext.Interface

Language access.

Specified by:

getLang in interface ExecutionContext.Interface

Returns:

The language currently set.

setBeep

public final void setBeep(boolean B_Enable)

Description copied from interface: ExecutionContext.Interface

Beep configuration setting.

Specified by:

setBeep in interface ExecutionContext.Interface

Parameters:

B_Enable - New value.

getBeep

public final boolean getBeep()

Description copied from interface: ExecutionContext.Interface

Beep configuration access.

Specified by:

getBeep in interface ExecutionContext.Interface

Returns:

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

watchResult

public final void watchResult(ExecutionResult CLI_Result)

Description copied from interface: ExecutionContext.Interface

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

Specified by:

watchResult in interface ExecutionContext.Interface

Parameters:

CLI_Result - Execution context to be watched.

run

public final boolean run(IODevice.Interface CLI_IODevice)

Description copied from interface: ExecutionContext.Interface

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

Specified by:

run in interface ExecutionContext.Interface

Parameters:

CLI_IODevice - Input/output device to run onto.

Returns:

true: success, false: failure.

run

public final boolean run()

Description copied from interface: ExecutionContext.Interface

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

Specified by:

run in interface ExecutionContext.Interface

Returns:

true: success, false: failure.

isRunning

public final boolean isRunning()

Description copied from interface: ExecutionContext.Interface

Tells whether this execution context is running or not.

Specified by:

isRunning in interface ExecutionContext.Interface

Returns:

The running status.

stopExecution

public final void stopExecution()

Description copied from interface: ExecutionContext.Interface

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

Specified by:

stopExecution in interface ExecutionContext.Interface

stopAllExecutions

public final void stopAllExecutions()

Description copied from interface: ExecutionContext.Interface

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.

Specified by:

stopAllExecutions in interface ExecutionContext.Interface