com.atlassian.bamboo.plan.cache

Interface ImmutableChain

All Superinterfaces:

BambooIdProvider, DescriptionProvider, ImmutableEntityWithOid, ImmutablePlan, NameProvider, PlanIdentifier, PlanKeyProvider, Triggerable

All Known Subinterfaces:

Chain, ChainBranch, ImmutableChainBranch, ImmutableTopLevelPlan, TopLevelPlan

All Known Implementing Classes:

AbstractChain, AbstractImmutableChain, ChainBranchImpl, DefaultChain, ImmutableChainBranchImpl, ImmutableChainImpl

public interface ImmutableChain
extends ImmutablePlan, Triggerable

Represents a Chain that is immutable. Since 3.4, all new uses of Chains should prefer this interface to improve cacheability.

Since:

v3.4

Field Summary

Fields inherited from interface com.atlassian.bamboo.plan.cache.ImmutablePlan

MAX_NUMBER_LOG_ENTRIES, MAX_PREVIOUS_BUILD_FOR_AVE, STATUS_CURRENTLY_BUILDING, STATUS_FAIL, STATUS_NO_BUILDS, STATUS_NOT_RUN, STATUS_SUCCESS

Fields inherited from interface com.atlassian.bamboo.plan.PlanIdentifier

getPlanKeyFunction, NAME_DELIMITER

Fields inherited from interface com.atlassian.bamboo.plan.PlanKeyProvider

getPlanKey

Method Summary

Modifier and Type	Method and Description
boolean	containsStage(String stageName) Checks whether or not a stage exists in this chain by stage name.
List<? extends ImmutableJob>	getAllJobs() Note: Does not include Jobs that are marked for deletion.
List<? extends ImmutableChainStage>	getAllStages() Get Stages of the Chain
Date	getCreationDate()
List<RepositoryDefinition>	getEffectiveRepositoryDefinitions() Deprecated. since 5.14
default BambooEntityType	getEntityType() Entity type of this object, used in BambooEntityOid.
int	getJobCount() Note: Does not include Jobs that are marked for deletion.
PlanResultKey	getLastResultKey() Get the latest result key including active (not finished) results
ImmutableChain	getMaster() Return the master plan if one exists.
NotificationSet	getNotificationSet() Get notifications defined for this plan.
List<PlanRepositoryDefinition>	getPlanRepositoryDefinitions() Return list of repositories available to the chain.
List<? extends ImmutableChainStage>	getStages() Get Stages of the chain.
ChainStorageTag	getStorageTag()
VcsBambooSpecsSource	getVcsBambooSpecsSource()
default VcsLocationBambooSpecsState	getVcsLocationBambooSpecsState() Deprecated. use getVcsBambooSpecsSource()

Methods inherited from interface com.atlassian.bamboo.plan.cache.ImmutablePlan

getAverageBuildDuration, getBuildDefinition, getBuildLogger, getCurrentStatus, getEffectiveVariables, getFirstBuildNumber, getKey, getLabelNames, getLastBuildNumber, getLatestResultsSummary, getProject, getType, getVariables, hasMaster, isActive, isBusy, isExecuting, isMarkedForDeletion

Methods inherited from interface com.atlassian.bamboo.plan.PlanIdentifier

getBuildKey, getBuildName, getDatabaseId, getId, getMasterId, getMasterIdIfExists, getName, getPlanKey, getPlanType, isSuspendedFromBuilding

Methods inherited from interface com.atlassian.bamboo.utils.DescriptionProvider

getDescription

Methods inherited from interface com.atlassian.bamboo.core.ImmutableEntityWithOid

getOid

Methods inherited from interface com.atlassian.bamboo.trigger.Triggerable

getTriggerDefinitions, isSuspended

Method Detail

getMaster

@Nullable
ImmutableChain getMaster()

Description copied from interface: ImmutablePlan

Return the master plan if one exists. The master is the plan which this one is derived from. Configuration is pulled from the master if one exists.

Specified by:

getMaster in interface ImmutablePlan

Returns:

the master Plan if one exists.

getNotificationSet

NotificationSet getNotificationSet()

Get notifications defined for this plan.

Returns:

NotificationSet containing notifications for this plan.

getStages

@NotNull
List<? extends ImmutableChainStage> getStages()

Get Stages of the chain.

Note that this excludes ChainStages that have been marked for deletion

Returns:

stages

getAllStages

@NotNull
List<? extends ImmutableChainStage> getAllStages()

Get Stages of the Chain

Note that this includes ChainStages that have been marked for deletion

Returns:

stages

containsStage

boolean containsStage(@Nullable
                      String stageName)

Checks whether or not a stage exists in this chain by stage name.

Parameters:

stageName - to check for

Returns:

true if a stage with the given name exists, otherwise false

getJobCount

int getJobCount()

Note: Does not include Jobs that are marked for deletion.

Returns:

how many Jobs are currently contained within this chain

getAllJobs

@NotNull
List<? extends ImmutableJob> getAllJobs()

Note: Does not include Jobs that are marked for deletion.

Returns:

a list of all Jobs that are currently contained within this chain - no order guaranteed.

getEffectiveRepositoryDefinitions

@NotNull
 @Deprecated
List<RepositoryDefinition> getEffectiveRepositoryDefinitions()

Deprecated. since 5.14

Return list of repositories available to the chain. In case of non-master object it will return list of master's repository definitions with default repository overridden by a private copy of default repository.

Returns:

ordered List of repositories available to this plan

getPlanRepositoryDefinitions

@NotNull
List<PlanRepositoryDefinition> getPlanRepositoryDefinitions()

Return list of repositories available to the chain. In case of non-master object it will return list of master's repository definitions with default repository overridden by a private copy of default repository.

Returns:

ordered List of repositories available to this plan

getLastResultKey

@Nullable
PlanResultKey getLastResultKey()

Get the latest result key including active (not finished) results

Returns:

The key of the last build. Returns null if there are no build results for this plan

getEntityType

default BambooEntityType getEntityType()

Description copied from interface: ImmutableEntityWithOid

Entity type of this object, used in BambooEntityOid.

Specified by:

getEntityType in interface ImmutableEntityWithOid

getStorageTag

ChainStorageTag getStorageTag()

getVcsLocationBambooSpecsState

@Deprecated
 @Nullable
default VcsLocationBambooSpecsState getVcsLocationBambooSpecsState()

Deprecated. use getVcsBambooSpecsSource()

getVcsBambooSpecsSource

@Nullable
VcsBambooSpecsSource getVcsBambooSpecsSource()

getCreationDate

@NotNull
Date getCreationDate()

Returns:

chain creation date

Since:

6.5