Package com.atlassian.bamboo.task
Class TaskResultBuilder
java.lang.Object
com.atlassian.bamboo.task.TaskResultBuilder
Evaluates the execution of
TaskType
s to produce a TaskResult
- Since:
- 3.1
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
checkInterceptorMatches
(@NotNull ContentMatchingInterceptor interceptor, int maximumAge) checkInterceptorNotMatches
(@NotNull ContentMatchingInterceptor interceptor, int maximumAge) checkReturnCode
(@NotNull com.atlassian.utils.process.ExternalProcess externalProcess) Checks that the return code of theExternalProcess
was zero Will only check return codes if the build state has not been set to Failed for some other reason.checkReturnCode
(@NotNull com.atlassian.utils.process.ExternalProcess externalProcess, int expectedReturnCode) Checks that the return code of theExternalProcess
was of the expected type.Checks whether any test failures have been recorded against the buildResult and updates the state accordingly Will only check tests if the build state has not been set to Failed for some other reason.static TaskResult
copyWithNewState
(@NotNull TaskResult taskResult, @NotNull TaskState newTaskState) Copies a taskResult and changes the statestatic TaskResultBuilder
create
(@NotNull TaskContext taskContext) Deprecated.static TaskResult
createFailedWithErrorResult
(TaskIdentifier taskIdentifier) Method to create error result bypassing the builder.failed()
Sets the Task Result Status asTaskState.FAILED
Sets the Task Result Status asTaskState.ERROR
static TaskResultBuilder
newBuilder
(@NotNull CommonTaskContext taskContext) Creates a new TaskResultBuilder for aCommonTaskContext
stop job execution after this task result processingsuccess()
Sets the Task Result Status asTaskState.SUCCESS
-
Method Details
-
newBuilder
Creates a new TaskResultBuilder for aCommonTaskContext
- Parameters:
taskContext
- of the executingTaskType
- Returns:
- evaluator
-
create
Deprecated.since 5.0 usenewBuilder(CommonTaskContext)
Creates a new TaskResultBuilder for aCommonTaskContext
- Parameters:
taskContext
- of the executingTaskType
- Returns:
- evaluator
-
copyWithNewState
public static TaskResult copyWithNewState(@NotNull @NotNull TaskResult taskResult, @NotNull @NotNull TaskState newTaskState) Copies a taskResult and changes the state- Parameters:
taskResult
- to copynewTaskState
- to replace the old taskState- Returns:
- the new TaskResult
-
createFailedWithErrorResult
Method to create error result bypassing the builder. Infrastructure related failures may not have a taskContext.- Parameters:
taskIdentifier
- identifying the task that failed- Returns:
- TaskResult.
-
success
Sets the Task Result Status asTaskState.SUCCESS
- Returns:
- the current TaskResultBuilder with updated status
-
failed
Sets the Task Result Status asTaskState.FAILED
- Returns:
- the current TaskResultBuilder with updated status
-
failedWithError
Sets the Task Result Status asTaskState.ERROR
- Returns:
- the current TaskResultBuilder with updated status
-
checkReturnCode
public TaskResultBuilder checkReturnCode(@NotNull @NotNull com.atlassian.utils.process.ExternalProcess externalProcess) Checks that the return code of theExternalProcess
was zero Will only check return codes if the build state has not been set to Failed for some other reason.- Parameters:
externalProcess
- - to check return code of- Returns:
- the current TaskResultBuilder with updated status based on the return code
-
checkReturnCode
public TaskResultBuilder checkReturnCode(@NotNull @NotNull com.atlassian.utils.process.ExternalProcess externalProcess, int expectedReturnCode) Checks that the return code of theExternalProcess
was of the expected type. Will only check return codes if the build state has not been set to Failed for some other reason.- Parameters:
externalProcess
- - process to check return code fromexpectedReturnCode
- - the return code to be considered a success.- Returns:
- the current TaskResultBuilder with updated status based on the return code
-
checkTestFailures
Checks whether any test failures have been recorded against the buildResult and updates the state accordingly Will only check tests if the build state has not been set to Failed for some other reason.- Returns:
- the current TaskResultBuilder with updated status based on the test outcome
-
checkInterceptorMatches
public TaskResultBuilder checkInterceptorMatches(@NotNull @NotNull ContentMatchingInterceptor interceptor, int maximumAge) -
checkInterceptorNotMatches
public TaskResultBuilder checkInterceptorNotMatches(@NotNull @NotNull ContentMatchingInterceptor interceptor, int maximumAge) -
build
-
getTaskState
-
setState
-
stopJobExecutionAfterTask
stop job execution after this task result processing
-
newBuilder(CommonTaskContext)