com.atlassian.bamboo.v2.build
Interface BuildContext

All Superinterfaces:
BuildIdentifier, java.io.Serializable
All Known Implementing Classes:
BuildContextImpl

@ThreadSafe
public interface BuildContext
extends BuildIdentifier

A class that encapsulates how to build a particular plan at a given instance


Method Summary
 BuildChanges getBuildChanges()
          Returns the build changes, if any, that represents the changes that triggered this build.
 BuildDefinition getBuildDefinition()
           
 BuildPlanDefinition getBuildPlanDefinition()
          Deprecated. since 2.7 use #getBuildDefinition
 CurrentBuildResult getBuildResult()
          The information about the results of a build
 ErrorCollection getErrorCollection()
          Any errors associated with the build
 BuildContext getParentBuildContext()
           
 TriggerReason getTriggerReason()
          The reason this build was triggered
 
Methods inherited from interface com.atlassian.bamboo.v2.build.BuildIdentifier
getBuildNumber, getBuildResultKey, getParentBuildIdentifier, getPlanId, getPlanKey, getPlanName, getPlanResultKey, getShortName
 

Method Detail

getParentBuildContext

@Nullable
BuildContext getParentBuildContext()
Returns:
the BuildContext of the parent Plan execution. Should return null if the current BuildContext is for a TopLevelPlan

getTriggerReason

@NotNull
TriggerReason getTriggerReason()
The reason this build was triggered

Returns:
triggerReason

getBuildPlanDefinition

@Deprecated
@NotNull
BuildPlanDefinition getBuildPlanDefinition()
Deprecated. since 2.7 use #getBuildDefinition

Returns:
buildPlanDefinition

getBuildDefinition

@NotNull
BuildDefinition getBuildDefinition()
Returns:
BuildDefinition associated with Plan this context relates to

getBuildChanges

@NotNull
BuildChanges getBuildChanges()
Returns the build changes, if any, that represents the changes that triggered this build.

Returns:
Never null. WIll return a build changes object with the approriate list of changes, the list will be null if no changes were found.

getBuildResult

@NotNull
CurrentBuildResult getBuildResult()
The information about the results of a build

Returns:
CurrentBuildResult

getErrorCollection

@NotNull
ErrorCollection getErrorCollection()
Any errors associated with the build



Copyright © 2010 Atlassian. All Rights Reserved.