org.threadly.load

Class SequentialScriptBuilder

java.lang.Object

org.threadly.load.AbstractScriptBuilder

org.threadly.load.SequentialScriptBuilder

public class SequentialScriptBuilder
extends AbstractScriptBuilder

A builder which's added steps will all be executed in sequence.

Constructor Summary

Constructors

Constructor and Description
SequentialScriptBuilder() Constructs a new SequentialScriptBuilder.

Method Summary

Modifier and Type	Method and Description
void	addStep(ScriptStep step) Adds a step to be run sequentially.
void	addSteps(ParallelScriptBuilder parallelSteps) Adds a set of steps which will run in parallel.
void	addSteps(SequentialScriptBuilder sequentialSteps) Adds a set of steps to be run sequentially.
int	getMaximumNeededThreadCount() Call to check how many threads this script will need to execute at the current build point.
boolean	hasSteps() Checks if the builder has had at least one step added to it.
SequentialScriptBuilder	makeCopy() Make a copy of the script chain.

Methods inherited from class org.threadly.load.AbstractScriptBuilder

addProgressFuture, addSteps, build, setMaxScriptStepRate

Methods inherited from class java.lang.Object

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

Constructor Detail

SequentialScriptBuilder

public SequentialScriptBuilder()

Constructs a new SequentialScriptBuilder. This can be used as either the start of a execution chain, or can later be provided into AbstractScriptBuilder.addSteps(SequentialScriptBuilder).

Method Detail

hasSteps

public boolean hasSteps()

Description copied from class: AbstractScriptBuilder

Checks if the builder has had at least one step added to it. If this returns false then this builder is effectively a no-op.

Specified by:

hasSteps in class AbstractScriptBuilder

Returns:

true if at least one step is attached to this builder

makeCopy

public SequentialScriptBuilder makeCopy()

Description copied from class: AbstractScriptBuilder

Make a copy of the script chain. This is necessary if you want to add the chain multiple times to another chain. The returned chain will execute the same script step instances (so if added to a parallel builder make sure the script steps are thread safe).

Specified by:

makeCopy in class AbstractScriptBuilder

Returns:

A copy builder

getMaximumNeededThreadCount

public int getMaximumNeededThreadCount()

Description copied from class: AbstractScriptBuilder

Call to check how many threads this script will need to execute at the current build point. This can give you an idea of how intensely parallel this script is. Though it should be known that less threads may be started than this. If the rate limiting is being used, depending on how fast test steps are completing not all threads may be used.

Overrides:

getMaximumNeededThreadCount in class AbstractScriptBuilder

Returns:

Number of threads to run script at it's most parallel point

addStep

public void addStep(ScriptStep step)

Adds a step to be run sequentially. This step will be ran after previously added steps have completed.

Specified by:

addStep in class AbstractScriptBuilder

Parameters:

step - Test step to be added

addSteps

public void addSteps(SequentialScriptBuilder sequentialSteps)

Adds a set of steps to be run sequentially. These sequential steps wont be started until all previously added steps have completed. The execution graph of the provided steps will be maintained. Future steps wont be executed till all provided steps are complete. The provided builder can not be modified after being provided. It also can not be provided as steps again. If needing to provide again, please use makeCopy().

Specified by:

addSteps in class AbstractScriptBuilder

Parameters:

sequentialSteps - Sequential steps to add to this builder

addSteps

public void addSteps(ParallelScriptBuilder parallelSteps)

Adds a set of steps which will run in parallel. The execution graph of the provided steps will be maintained. So the provided parallel steps will run in parallel as built, and future steps added to this builder will not be executed till this provided builder has finished running. The provided builder can not be modified after being provided. It also can not be provided as steps again. If needing to provide again, please use makeCopy().

Specified by:

addSteps in class AbstractScriptBuilder

Parameters:

parallelSteps - Parallel steps to add to this builder