com.tplan.robot.scripting.interpret

Class ScriptCompilerQueue

java.lang.Object

com.tplan.robot.scripting.interpret.ScriptCompilerQueue

public class ScriptCompilerQueue
extends Object

Queue managing script compilation requests from the GUI (since 4.4.4). It ensures synchronization and efficiency of script compilation triggered by:

• Opening of the script in the editor
• Interaction with the report, template and output path fields in the Tools panel
• Script edits in the editor
• Undo and redo
• Save or save as
• Manual compilation requests (the "Compile" menu item)

Queue architecture:

• Compilation is performed in separate threads to avoid GUI freezes caused by blocking of the AWT dispatch thread.
• When a compilation is requested while another one is processed it gets skipped unless the force parameter is set to true.
• When forcing is on the queue first stops the running compilation process and waits until it finishes before starting a new one.

Since:

4.4.4

T-Plan Robot Enterprise, (C) 2009-2022 T-Plan Limited. All rights reserved.

Method Summary

Modifier and Type	Method and Description
static void	compile(TestScriptInterpret script, ScriptingContext context, ActionListener a, boolean force) Request a new compilation.
static boolean	isQueueEnabled() Test out whether the queue is enabled, i.e.
static void	start() Start accepting the compile requests.
static void	stop(int maxWaitMs) Stop accepting the compile requests.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

isQueueEnabled

public static boolean isQueueEnabled()

Test out whether the queue is enabled, i.e. open to requests from the GUI.

Returns:

true if enabled or false otherwise.

start

public static void start()

Start accepting the compile requests.

stop

public static void stop(int maxWaitMs)

Stop accepting the compile requests.

Parameters:

maxWaitMs - how long to wait for all queued compiler tasks to finish at a maximum (milliseconds). Use a value <= 0 to set off waiting.

compile

public static void compile(TestScriptInterpret script,
                           ScriptingContext context,
                           ActionListener a,
                           boolean force)

Request a new compilation.

Parameters:

script - the test script.

context - a custom context instance. Use null to let the process create a new context and make it available through TestScriptInterpret.getCompilationContext().

a - an optional action listener to be notified after the request is completed (i.e. either skipped or compiled).

force - the value of true will terminate any eventual running compilation process before starting a new one. The value of false will skip the compilation if the script is already being compiled.