com.tplan.robot.scripting.interpret

Class ScriptReferenceLocation

java.lang.Object

com.tplan.robot.scripting.interpret.ScriptLocation

com.tplan.robot.scripting.interpret.ScriptReferenceLocation

All Implemented Interfaces:

Cloneable, Comparable, Comparator<ScriptLocation>

public class ScriptReferenceLocation
extends ScriptLocation

Represents location of a reference (typically a file one) in a test script. It allows to identify the place in a test script by the specified element, reference (a link to another resource such as a template image, collection or a script) and the parameter that contains the reference. Such an identification is more robust than the other used ones, such as by the document offset, and it keeps working even if after the script gets updated as long as the document model (the tree of elements) is not reset.

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

Field Summary

Fields

Modifier and Type	Field and Description
String	parameter
String	reference
boolean	relative
int	scriptType

Fields inherited from class com.tplan.robot.scripting.interpret.ScriptLocation

columnIndex, command, element, lineIndex, scriptFile, source

Constructor Summary

Constructors

Constructor and Description
ScriptReferenceLocation(int scriptType)
ScriptReferenceLocation(ScriptingContext ctx, int scriptType)

Method Summary

Modifier and Type	Method and Description
int[]	getRange() Get the start offset and length of the reference in the current document.

Methods inherited from class com.tplan.robot.scripting.interpret.ScriptLocation

compare, compareTo, createCopy, equalsToCurrentPosition, getOffset, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Comparator

comparing, comparing, comparingDouble, comparingInt, comparingLong, equals, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Field Detail

relative

public boolean relative

reference

public String reference

parameter

public String parameter

scriptType

public final int scriptType

Constructor Detail

ScriptReferenceLocation

public ScriptReferenceLocation(int scriptType)

ScriptReferenceLocation

public ScriptReferenceLocation(ScriptingContext ctx,
                               int scriptType)

Method Detail

getRange

public int[] getRange()

Get the start offset and length of the reference in the current document.

Returns:

the range of [start, length].