com.atlassian.bamboo.ww2.beans

Class DecoratedPlan.DecoratedBranch

java.lang.Object

com.atlassian.bamboo.ww2.beans.DecoratedPlan

com.atlassian.bamboo.ww2.beans.DecoratedPlan.DecoratedBranch

All Implemented Interfaces:

BambooIdProvider, PlanIdentifier, PlanKeyProvider, DescriptionProvider, NameProvider, DecoratedNavObject

Enclosing class:

DecoratedPlan

public static class DecoratedPlan.DecoratedBranch
extends DecoratedPlan

Branches are top level branch plans. DecoratedBranches do not track stages or jobs themselves but inherit those of their master chain.

Nested Class Summary

Nested classes/interfaces inherited from class com.atlassian.bamboo.ww2.beans.DecoratedPlan

DecoratedPlan.DecoratedBranch, DecoratedPlan.DecoratedPlanBranchGist

Field Summary

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

NAME_DELIMITER

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

getPlanKey

Constructor Summary

Constructors

Constructor and Description
DecoratedBranch(@NotNull DecoratedNavObjectFactory decoratedNavObjectFactory, @NotNull ImmutableChainBranch branch, @NotNull DecoratedPlan master)

Method Summary

Modifier and Type	Method and Description
@Nullable String	getBranchName()
@NotNull DecoratedPlan	getMaster() The master plan iff the plan is a branched plan and it has a master.
@NotNull PlanBranchMetadata	getMetadata()
@Nullable DecoratedPlan	getParent()
@Nullable PlanBranchWorkflow	getPlanBranchWorkflow() For plan branches, this value indicates which workflow led to creation of this particular plan branch.
List<DeploymentProject>	getRelatedDeploymentProjects()
com.google.common.collect.ImmutableList<DecoratedStage>	getStages()
@Nullable DecoratedStage	getStageWithName(@NotNull String stageName) Retrieve the named stage.
boolean	isAwaitingSpecsExecution()
boolean	isDivergent()

Methods inherited from class com.atlassian.bamboo.ww2.beans.DecoratedPlan

getBranches, getBranchPlanKey, getBuildKey, getBuildName, getDatabaseId, getDescription, getDisplayName, getId, getKey, getLabelNames, getLinkedJiraIssue, getMasterChainKey, getMasterId, getMasterIdIfExists, getMasterJobKey, getName, getNavGroups, getPlanKey, getPlanType, getProject, getStatus, getType, isRemoteJiraLinkRequired, isResult, isSuspendedFromBuilding, replaceKey, setLabels

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DecoratedBranch

public DecoratedBranch(@NotNull
                       @NotNull DecoratedNavObjectFactory decoratedNavObjectFactory,
                       @NotNull
                       @NotNull ImmutableChainBranch branch,
                       @NotNull
                       @NotNull DecoratedPlan master)

Method Detail

getMaster

@NotNull
public @NotNull DecoratedPlan getMaster()

Description copied from interface: DecoratedNavObject

The master plan iff the plan is a branched plan and it has a master.

Specified by:

getMaster in interface DecoratedNavObject

Specified by:

getMaster in class DecoratedPlan

Returns:

getRelatedDeploymentProjects

public List<DeploymentProject> getRelatedDeploymentProjects()

Specified by:

getRelatedDeploymentProjects in class DecoratedPlan

getParent

@Nullable
public @Nullable DecoratedPlan getParent()

Specified by:

getParent in interface DecoratedNavObject

Specified by:

getParent in class DecoratedPlan

Returns:

the parent of this object (does not take into account groups)

getBranchName

@Nullable
public @Nullable String getBranchName()

Specified by:

getBranchName in class DecoratedPlan

isDivergent

public boolean isDivergent()

isAwaitingSpecsExecution

public boolean isAwaitingSpecsExecution()

getPlanBranchWorkflow

@Nullable
public @Nullable PlanBranchWorkflow getPlanBranchWorkflow()

For plan branches, this value indicates which workflow led to creation of this particular plan branch.

Specified by:

getPlanBranchWorkflow in class DecoratedPlan

getMetadata

@NotNull
public @NotNull PlanBranchMetadata getMetadata()

getStageWithName

@Nullable
public @Nullable DecoratedStage getStageWithName(@NotNull
                                                           @NotNull String stageName)

Description copied from class: DecoratedPlan

Retrieve the named stage. If the stage is not found it indicates that the stage has been deleted or renamed but the result remains.

Specified by:

getStageWithName in class DecoratedPlan

getStages

public com.google.common.collect.ImmutableList<DecoratedStage> getStages()

Overrides:

getStages in class DecoratedPlan