org.threadly.load

Interface StepResult

public interface StepResult

Interface which represents the result of an executed test step. This provides if the test completed in error (via getError() being not null). As well as the runtime it took to execute the test step.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() Get description of the test.
java.lang.Throwable	getError() Get the error result if it occurred.
long	getRunTime(java.util.concurrent.TimeUnit desiredUnit) Check how long the test executed for until it completed normally, or in an error state.
boolean	wasMaintanceStep() Indicates if the result of this step was of type ScriptStepType.Maintenance or ScriptStepType.AsyncMaintenance.

Method Detail

wasMaintanceStep

boolean wasMaintanceStep()

Indicates if the result of this step was of type ScriptStepType.Maintenance or ScriptStepType.AsyncMaintenance. In either of those conditions the run time will always be zero, and thus should not be included in the resulting statistics.

Returns:

true if the step was a maintance step

getDescription

java.lang.String getDescription()

Get description of the test.

Returns:

Description of ran test

getRunTime

long getRunTime(java.util.concurrent.TimeUnit desiredUnit)

Check how long the test executed for until it completed normally, or in an error state.

Parameters:

desiredUnit - TimeUnit which result should be provided in

Returns:

nanosecond test executed for

getError

java.lang.Throwable getError()

Get the error result if it occurred. This will return null if the test completed normally.

Returns:

Thrown error during execution or null if executed normally