com.tplan.robot.scripting

Interface DynamicVariable

public interface DynamicVariable

This intefrace allows to add custom dynamic variables through the plug in interface. A dynamic variable is a variable whose value is calculated every time the variable gets called from a script. For example, one of the default dynamic variables called "_CURTIME" calls internally the System.currentTimeMillis() method to return actual time in milliseconds. For the list of such variables see the Var command documentation.

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

Method Summary

Modifier and Type	Method and Description
void	contextCreated(ScriptingContext ctx) This method gets called whenever a new scripting context is created.
String	getCode() Get the variable name.
String	toString(String varName, Map cliVars, Map variables, TestWrapper wr, ScriptingContext ctx) Get the variable value.

Method Detail

getCode

String getCode()

Get the variable name.

Returns:

variable name. Make sure it doesn't conflict with any default variable.

toString

String toString(String varName,
                Map cliVars,
                Map variables,
                TestWrapper wr,
                ScriptingContext ctx)

Get the variable value. This method will be called any time the variable gets referenced from the test script. As script variables are generally String values, the result must be a String. This method is not supposed to add itself to the variable map - this will be handled by the script manager.

Parameters:

varName - variable name

cliVars - map of variables [name, value] passed in to the script through the -v/--variable CLI option.

variables - current map of variables [name, value].

wr - current test wrapper.

ctx - scripting context.

Returns:

variable value in form of String.

contextCreated

void contextCreated(ScriptingContext ctx)

This method gets called whenever a new scripting context is created. Dynamic variables which have default values are welcome to populate themselves in the context through the ScriptingContext.setVariable(java.lang.String, java.lang.Object) method.

Parameters:

ctx - newly created context.