com.tplan.robot.scripting.interpret

Interface RefactoringCapable

All Known Implementing Classes:

Schedule

public interface RefactoringCapable

Interface declaring that the interpret can identify and carry out refactoring after one or more resources were copied and/or moved. This usually involves updating of those lines of code that link to the relocated resource.

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

Method Summary

Modifier and Type	Method and Description
List<RefactoringTask>	getFileMoveOrCopyRefactoringTasks(Map<File,File> changes) Get the list of refactoring tasks for the argument map of file updates.
List<File>	getTemporaryFiles(File scriptFile) Get the temporary files created by the script.
void	refactoringCompleted() Called after the refactoring of the tasks returned by the implementing object gets successfully completed.

Method Detail

getFileMoveOrCopyRefactoringTasks

List<RefactoringTask> getFileMoveOrCopyRefactoringTasks(Map<File,File> changes)

Get the list of refactoring tasks for the argument map of file updates.

Parameters:

changes - a map of [newFile, oldFile] pairs identifying the files that were moved or copied.

Returns:

the list of atomic refactoring tasks. One such a task typically represents update of a resource reference in a single location of the script.

getTemporaryFiles

List<File> getTemporaryFiles(File scriptFile)

Get the temporary files created by the script. For example, a Java test script may have one or more .class files in the classes/ folder. A TPR script may also produce .class files resulting from a compilation of a Java code block.

The method should work even if the script source code hasn't been loaded yet. Rather than caching the list of created files and returning it the method should query the local file system and search the usual locations for files that meet a certain pattern. For example, a Java test script may expect that the /classes folder will contain the compiled code as one or more .class files of known name or name pattern.

Parameters:

scriptFile - optional script file to be used when the test script interpret hasn't been associated with a file (URI) yet. If the argument is null the interpret must default to the file returned by TestScriptInterpret.getURI().

Returns:

the list of temporary files, typically for deletion purposes.

refactoringCompleted

void refactoringCompleted()

Called after the refactoring of the tasks returned by the implementing object gets successfully completed.

Since:

4.0