com.atlassian.bamboo.v2.build
Interface CurrentBuildResult

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
CurrentBuildResultImpl

public interface CurrentBuildResult
extends java.io.Serializable

Interface that defines the partial output of a plan being built


Field Summary
static java.lang.String CBD_BUILD_TIME_STAMP
          Key name in custom build data
 
Method Summary
 void addBuildErrors(java.util.List<java.lang.String> errorMessages)
           
 void appendTestResults(java.util.Set<TestResults> successfulTestResults, java.util.Set<TestResults> failedTestResults, java.util.Set<TestResults> skippedTestResults)
          Append test results to the existing stored test results for this build.
 void clearBuildErrors()
           
 BuildResults cloneAsBuildResults(BuildContext buildContext, ReasonForBuild reasonForBuild)
           
 java.util.List<java.lang.String> getBuildErrors()
           
 int getBuildReturnCode()
           
 BuildState getBuildState()
           
 java.util.Map<java.lang.String,java.lang.String> getCustomBuildData()
          Returns a map of string keyed strings for storing arbitrary data
 java.util.Collection<TestResults> getFailedTestResults()
          Returns TestResults for the tests that have failed during current build.
 LifeCycleState getLifeCycleState()
           
 java.util.Collection<TestResults> getSkippedTestResults()
          Returns TestResults for the tests that were skipped (or inconclusive) during current build.
 java.util.Collection<TestResults> getSuccessfulTestResults()
          Returns TestResults for the tests that were successful during current build.
 java.util.List<TaskResult> getTaskResults()
           
 java.util.List<TaskResult> getTaskResultsForTask(java.lang.String pluginKey)
           
 boolean isCheckoutSuccess()
           
 boolean isStarted()
           
 void setBuildReturnCode(int buildReturnCode)
           
 void setBuildState(BuildState buildState)
           
 void setCheckoutSuccess(boolean checkoutSuccess)
           
 void setLifeCycleState(LifeCycleState lifeCycleState)
           
 void setStarted(boolean started)
           
 void setTaskResults(java.util.List<TaskResult> taskResults)
           
 void setTestResults(java.util.Set<TestResults> successfulTestResults, java.util.Set<TestResults> failedTestResults)
          Set the test results for this build.
 void setTestResults(java.util.Set<TestResults> successfulTestResults, java.util.Set<TestResults> failedTestResults, java.util.Set<TestResults> skippedTestResults)
          Set the test results for this build.
 

Field Detail

CBD_BUILD_TIME_STAMP

static final java.lang.String CBD_BUILD_TIME_STAMP
Key name in custom build data

See Also:
Constant Field Values
Method Detail

getBuildState

@NotNull
BuildState getBuildState()

setBuildState

void setBuildState(@NotNull
                   BuildState buildState)

getLifeCycleState

@NotNull
LifeCycleState getLifeCycleState()

setLifeCycleState

void setLifeCycleState(@NotNull
                       LifeCycleState lifeCycleState)

isStarted

boolean isStarted()

setStarted

void setStarted(boolean started)

getBuildReturnCode

int getBuildReturnCode()

setBuildReturnCode

void setBuildReturnCode(int buildReturnCode)

getCustomBuildData

@NotNull
java.util.Map<java.lang.String,java.lang.String> getCustomBuildData()
Returns a map of string keyed strings for storing arbitrary data

Returns:

addBuildErrors

void addBuildErrors(@Nullable
                    java.util.List<java.lang.String> errorMessages)

getBuildErrors

@NotNull
java.util.List<java.lang.String> getBuildErrors()

clearBuildErrors

void clearBuildErrors()

getFailedTestResults

@Nullable
java.util.Collection<TestResults> getFailedTestResults()
Returns TestResults for the tests that have failed during current build.

Returns:

getSuccessfulTestResults

@Nullable
java.util.Collection<TestResults> getSuccessfulTestResults()
Returns TestResults for the tests that were successful during current build.

Returns:

getSkippedTestResults

@Nullable
java.util.Collection<TestResults> getSkippedTestResults()
Returns TestResults for the tests that were skipped (or inconclusive) during current build.

Returns:

setTestResults

void setTestResults(@Nullable
                    java.util.Set<TestResults> successfulTestResults,
                    @Nullable
                    java.util.Set<TestResults> failedTestResults,
                    @Nullable
                    java.util.Set<TestResults> skippedTestResults)
Set the test results for this build. You most likely dont want to use this as other tasks or plugins may have already added tests. Use appendTestResults(Set, Set, Set) instead.

Parameters:
successfulTestResults - a set of successful results retrieved from the build
failedTestResults - a set of failed results retrieved from the build
skippedTestResults - s set of skipped results retrieved from the build

setTestResults

void setTestResults(@Nullable
                    java.util.Set<TestResults> successfulTestResults,
                    @Nullable
                    java.util.Set<TestResults> failedTestResults)
Set the test results for this build. You most likely dont want to use this as other tasks or plugins may have already added tests. Use appendTestResults(Set, Set, Set) instead.

Parameters:
successfulTestResults - a set of successful results retrieved from the build
failedTestResults - a set of failed results retrieved from the build

appendTestResults

void appendTestResults(@Nullable
                       java.util.Set<TestResults> successfulTestResults,
                       @Nullable
                       java.util.Set<TestResults> failedTestResults,
                       @Nullable
                       java.util.Set<TestResults> skippedTestResults)
Append test results to the existing stored test results for this build. Leave arguments null or empty if you have nothing in that category append.

Parameters:
successfulTestResults - - any new successful tests
failedTestResults - - any new failed tests
skippedTestResults - - any new skipped tests

cloneAsBuildResults

BuildResults cloneAsBuildResults(BuildContext buildContext,
                                 ReasonForBuild reasonForBuild)

isCheckoutSuccess

boolean isCheckoutSuccess()

setCheckoutSuccess

void setCheckoutSuccess(boolean checkoutSuccess)

getTaskResults

@Nullable
java.util.List<TaskResult> getTaskResults()

setTaskResults

void setTaskResults(java.util.List<TaskResult> taskResults)

getTaskResultsForTask

java.util.List<TaskResult> getTaskResultsForTask(@NotNull
                                                 java.lang.String pluginKey)


Copyright © 2012 Atlassian. All Rights Reserved.