T-Plan Robot Enterprise 5.0.1
Build No. 5.0.1-20190308.1

Package com.tplan.robot.scripting

The test script framework and API.

See:
          Description

Interface Summary
ComparisonFailureListener Interface declaring fall back methods to be called when image comparison fails.
ConversionEvaluator Interface declaring conversion methods used by the Java method mapper.
DisconnectListener Interface declaring fall back methods to be called when a connection to the desktop is unexpectedly interrupted during a script execution.
DocumentWrapper Document wrapper encapsulates a styled document with a test script or its part specified by a start and end document elements.
DynamicVariable This intefrace allows to add custom dynamic variables through the plug in interface.
ExecutionListener Pluggable interface for objects which need to attach to a script execution.
ExpressionEvaluator Numeric and boolean expression evaluator methods.
FileBasedJavaConverter Interface for second generation converter of the TPR scripting language to Java code.
JavaTestScript Java test script interface.
JavaTestScriptConverter Functional interface of converter from the proprietary scripting language to Java.
ParametrizedTestScript Methods to declare parameters of a Java test script.
RepeatingScriptedExecutable Scripted executable supporting multiple executions.
ScriptedExecutable Interface declaring basic status methods of a scripted executable object (test script, test suite, schedule, ...).
ScriptingContext Scripting context is a map which serves as a repository of objects and structures related to script execution.
ScriptListener Listener interface for objects wishing to register for script events.
ScriptManager Script manager public interface.
TestWrapper High level interface for the family of test script wrappers.
TokenParser Token parser is responsible for breaking down individual test commands into elements representing the command name, arguments and parameters.
 

Class Summary
AbstractJavaTestScript Base class for the default Java test script.
CommentCollector Utility capable of collecting of script comments and exporting them in various formats (plain text, HTML, MS Word).
ConnectionTimeout A simple utility runnable used to wait for a desktop connection to be established or restored.
DefaultJavaTestScript Default Java test script.
DynamicVariableFactory Plugin factory for objects implementing the DynamicVariable interface.
ExecOrCompileThread A thread allowing to run a test script compilation or execution of an interpret or a sequence of interprets as a separate thread.
ExecutionFallBackManager Provides fallback mechanism to handle I/O errors such as for example desktop connection failures experienced at the time of script execution.
ExecutionListenerFactory Plugin factory for objects which implementing the ExecutionListener interface.
JavaTestScriptConverterFactory Pluggable factory of converters from the proprietary scripting language to Java.
JavaTestScriptMethodMapper Mapper of scripting language commands onto calls of Java methods provided by the DefaultJavaTestScript class.
NumericEvaluator Parser and evaluator of numeric and boolean expressions as is defined in the Numeric Expressions and Boolean Expressions chapters of the T-Plan Robot Enterprise language specification.
RelativePoint Extension of java.awt.Point class allowing to specify the coordinates as percentages instead of absolute numbers.
ScriptDebuggingEvent Script event used for additional messages fired in debugging mode.
ScriptEvent Script events describe events related to test script execution like start, stop and pause, execution of particular commands etc.
ScriptingContextImpl Scripting context implementation.
ScriptManagerImpl Script manager implementation.
TemplateImageBean Template image bean is a container for data from the template image meta data file.
TokenParserImpl Token parser implementation.
 

Exception Summary
PauseRequestException Exception thrown during test script execution indicating that pause was requested either by the user (through GUI) or programatically .
StopRequestException Exception thrown during test script execution indicating that the script was terminated either by the user (through GUI) or programatically.
SyntaxErrorException Exception thrown during test script validation indicating that the script contains a syntax error.
UnresolvedVariableCallException Exception thrown by the compiler when the evaluated TPR language element contains an unresolved variable call.
 

Annotation Types Summary
DefaultJavaTestScript.Command  
DefaultJavaTestScript.Param  
 

Package com.tplan.robot.scripting Description

The test script framework and API.


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


T-Plan Robot Enterprise 5.0.1
Build No. 5.0.1-20190308.1