org.threadly.load

Enum ScriptStepType

java.lang.Object

java.lang.Enum<ScriptStepType>

org.threadly.load.ScriptStepType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ScriptStepType>

public enum ScriptStepType
extends java.lang.Enum<ScriptStepType>

Indicates what type of step this is. Use of Maintenance and AsyncMaintenance allows you to do operations without having the statistics and results included in the final results. In addition the use of specifically AsyncMaintenance allows ambush to try and reduce the impact of running the step.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AsyncMaintenance Similar to Maintenance this step will not have results or statistics recorded.
Maintenance A maintenance step indicates that the results of the step should NOT be considered in completion statistics.
Normal This indicates a normal test step.

Method Summary

Modifier and Type	Method and Description
static ScriptStepType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ScriptStepType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Normal

public static final ScriptStepType Normal

This indicates a normal test step. Meaning it will be ran in the chain normally, and the results of the step will be gathered and recorded.

Maintenance

public static final ScriptStepType Maintenance

A maintenance step indicates that the results of the step should NOT be considered in completion statistics. However failure conditions from a maintenance step will halt the script. This is a step which basically is doing internal operations to assist the test. If it is not critical when the step runs, and a failure of this step should not fail the script use AsyncMaintenance as a typically better option.

AsyncMaintenance

public static final ScriptStepType AsyncMaintenance

Similar to Maintenance this step will not have results or statistics recorded. There are two critical differences however with this. The first being that a failure from an async step will NOT halt or fail the script. This is because we must mark the step as complete before actual execution to ensure that script progression continues. The second difference being is that this step's execution point is arbitrary. Ambush will _attempt_ to run it at a point where the impact to other steps will be minimized. The earliest execution could start is dependent in how it is constructed in the script step chain.

Method Detail

values

public static ScriptStepType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ScriptStepType c : ScriptStepType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ScriptStepType valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null