|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectabbot.script.StepRunner
Provides control and tracking of the execution of a step or series of steps. By default the runner stops execution on the first encountered failure/error. The running environment is preserved to the extent possible, which includes discarding any GUI components created by the code under test.
If you wish to preserve the application state when there is an error,
you can use the method setTerminateOnError(false)
.
Field Summary | |
protected Hierarchy |
hierarchy
|
Constructor Summary | |
StepRunner()
This ctor uses a new instance of TestHierarchy as the default Hierarchy. |
|
StepRunner(Hierarchy h)
Create a new runner. |
Method Summary | |
void |
addStepListener(StepListener sl)
|
protected void |
clearErrors()
|
protected void |
fireStepEnd(Step step)
|
protected void |
fireStepError(Step step,
Throwable thr)
|
protected void |
fireStepEvent(StepEvent event)
If this is used to propagate a failure/error, be sure to invoke setError on the step first. |
protected void |
fireStepFailure(Step step,
Throwable afe)
|
protected void |
fireStepProgress(Step step,
int val)
|
protected void |
fireStepStart(Step step)
|
Throwable |
getError(Step step)
|
protected Hierarchy |
getHierarchy()
|
boolean |
getStopOnError()
|
boolean |
getStopOnFailure()
|
boolean |
getTerminateOnError()
|
void |
launch(Script script)
Invoke the given script's launch step, if any. |
void |
removeStepListener(StepListener sl)
|
protected void |
restore()
Restore (to the extent possible) the environment prior to running. |
void |
run(Step step)
Run the given script, propagating any failures or errors. |
protected void |
runStep(Step step)
Main run method, which stores any failures or exceptions for later retrieval. |
protected void |
save()
|
protected void |
setError(Step step,
Throwable thr)
|
void |
setStopOnError(boolean stop)
|
void |
setStopOnFailure(boolean stop)
|
void |
setTerminateOnError(boolean state)
Set whether the application under test should be terminated when an error is encountered and script execution stopped. |
protected void |
setUp()
Set up an appropriate environment for launching an app under test. |
void |
stop()
Stop execution of the script after the current step completes. |
void |
stop(boolean terminate)
Stop execution, indicating whether to terminate the app. |
boolean |
stopped()
Return whether the runner has been stopped. |
void |
terminate()
Dispose of any extant windows and restore any saved environment state. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected Hierarchy hierarchy
Constructor Detail |
public StepRunner()
public StepRunner(Hierarchy h)
Method Detail |
protected Hierarchy getHierarchy()
public void setStopOnFailure(boolean stop)
public void setStopOnError(boolean stop)
public boolean getStopOnFailure()
public boolean getStopOnError()
public void stop()
public void stop(boolean terminate)
public boolean stopped()
protected void setUp()
protected void save()
protected void restore()
public void run(Step step) throws Throwable
terminate()
method will be invoked if the script is
stopped for any reason, unless setTerminateOnError(false)
has been called. Otherwise terminate()
will only be
called if there is a Terminate
step within the script
itself.
Throwable
terminate()
public void setTerminateOnError(boolean state)
public boolean getTerminateOnError()
protected void clearErrors()
protected void runStep(Step step) throws Throwable
Throwable
public void launch(Script script) throws Throwable
Throwable
public void terminate()
protected void setError(Step step, Throwable thr)
public Throwable getError(Step step)
public void addStepListener(StepListener sl)
public void removeStepListener(StepListener sl)
protected void fireStepEvent(StepEvent event)
protected void fireStepStart(Step step)
protected void fireStepProgress(Step step, int val)
protected void fireStepEnd(Step step)
protected void fireStepFailure(Step step, Throwable afe)
protected void fireStepError(Step step, Throwable thr)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |