com.tplan.robot.scripting.interpret

Interface RefactoringTask

All Superinterfaces:

Comparable

public interface RefactoringTask
extends Comparable

Interface of a refactoring task which typically represents an atomic update of the test script code, for example an update of a resource (template image, subscript) called by a command after the resource was moved to a different location.

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

Method Summary

Modifier and Type	Method and Description
boolean	execute() Carry out the update.
ScriptReferenceLocation	getLocation() Get the update location.
String	getQuestion() Get the question to display should the user wish to approve every single update.
File	getSource() Get the source file (the original file before it was updated).
File	getTarget() Get the target file (where the source file returned by getSource() was moved or copied to).
void	setReplaceWithParent(boolean replaceWithParent) Set the parent replacement mode.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getLocation

ScriptReferenceLocation getLocation()

Get the update location.

Returns:

the update location.

getQuestion

String getQuestion()

Get the question to display should the user wish to approve every single update.

Returns:

the confirmation question to display, for example "Update the reference to the ABC image in the XYZ command?".

execute

boolean execute()

Carry out the update.

Returns:

true if the update was performed properly or false if not.

setReplaceWithParent

void setReplaceWithParent(boolean replaceWithParent)

Set the parent replacement mode. When enabled the task should replace all references of the updated file with the name of the new parent folder. This is used for image comparison updates where a single image file is being moved to a new collection (folder) and we need the comparison command to use the collection instead.

Parameters:

replaceWithParent - true will enable parent replacement, false disable. The mode is by default disabled.

getSource

File getSource()

Get the source file (the original file before it was updated).

Returns:

the source file.

getTarget

File getTarget()

Get the target file (where the source file returned by getSource() was moved or copied to).

Returns:

the target file.