com.atlassian.bamboo.plan

Class PlanHelper

java.lang.Object

com.atlassian.bamboo.plan.PlanHelper

public final class PlanHelper
extends Object

Method Summary

Modifier and Type	Method and Description
static Predicate<ImmutableChain>	defaultRepositoryAsRootPredicate(long repositoryId) passes chains when the default plan repository definition points to root definition with given id
static ImmutableJob	getBranchedImmutableJob(ImmutableChain chainBranch, ImmutableJob masterJob) Searches for a corresponding job in a branch.
static ImmutableChainStage	getBranchedStage(ImmutableChain chainBranch, ImmutableChainStage masterStage)
static Stream<ImmutableJob>	getBranchesForJob(CachedPlanManager cachedPlanManager, ImmutableJob masterJob)
static <T> T	getConfigObject(BuildDefinition planDefinition, String key, Class<T> clazz)
static <T> T	getConfigObject(ImmutablePlan plan, String key, Class<T> clazz)
static String	getCurrentStatus(ImmutablePlan plan)
static PlanRepositoryDefinition	getDefaultPlanRepositoryDefinition(ImmutablePlan plan)
static Set<PlanKey>	getMasterAndBranchesKeys(CachedPlanManager cachedPlanManager, PlanKey masterOrBranchKey) Get keys of all branches and master plan.
static Chain	getMasterPlan(Chain plan) Get master plan if plan has master or passed plan otherwise.
static ImmutableChain	getMasterPlan(ImmutableChain plan) Get master plan if plan has master or passed plan otherwise.
static ImmutablePlan	getMasterPlan(ImmutablePlan plan) Get master plan if plan has master or passed plan otherwise.
static PlanKey	getMasterPlanKey(ImmutablePlan plan) Get planKey of master plan if plan has master or planKey of passed plan otherwise.
static long	getPermissionPlanId(ImmutablePlan plan)
static Set<PlanKey>	getPlanKeysOfBranchesSharingConfiguration(CachedPlanManager cachedPlanManager, PlanKey masterOrBranchKey) Get keys of all branches (including master plan if applicable) that share the configuration.
static PlanRepositoryDefinition	getPlanRepositoryDefinitionById(ImmutablePlan plan, long id)
static LinkedHashMap<Long,PlanRepositoryDefinition>	getPlanRepositoryDefinitionMap(ImmutablePlan plan)
static List<PlanRepositoryDefinition>	getPlanRepositoryDefinitions(ImmutablePlan plan)
static List<PlanRepositoryDefinition>	getPlanRepositoryDefinitionsByType(ImmutablePlan plan, String pluginKey)
static boolean	hasMultipleBranches(CachedPlanManager cachedPlanManager, PlanKey planKey)
static boolean	haveTheSameMaster(CachedPlanManager cachedPlanManager, ImmutableChain masterOrBranchA, ImmutableChain masterOrBranchB)
static boolean	haveTheSameMaster(CachedPlanManager cachedPlanManager, PlanKey masterOrBranchKeyA, PlanKey masterOrBranchKeyB)
static boolean	isDefault(PlanRepositoryDefinition repositoryDefinition)
static boolean	isDivergentBranch(ImmutableChain chain)
static boolean	isDivergentBranch(ImmutablePlan plan)

Methods inherited from class java.lang.Object

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

Method Detail

isDivergentBranch

public static boolean isDivergentBranch(@NotNull
                                        ImmutablePlan plan)

Returns:

true if plan is a plan branch of a job of a plan branch and plan branch is divergent

isDivergentBranch

public static boolean isDivergentBranch(@NotNull
                                        ImmutableChain chain)

Returns:

true if plan is a plan branch of a job of a plan branch and plan branch is divergent

getPlanRepositoryDefinitionMap

@NotNull
public static LinkedHashMap<Long,PlanRepositoryDefinition> getPlanRepositoryDefinitionMap(@NotNull
                                                                                                   ImmutablePlan plan)

getPlanRepositoryDefinitions

public static List<PlanRepositoryDefinition> getPlanRepositoryDefinitions(@NotNull
                                                                          ImmutablePlan plan)

getPlanRepositoryDefinitionsByType

public static List<PlanRepositoryDefinition> getPlanRepositoryDefinitionsByType(@NotNull
                                                                                ImmutablePlan plan,
                                                                                @NotNull
                                                                                String pluginKey)

getPlanRepositoryDefinitionById

public static PlanRepositoryDefinition getPlanRepositoryDefinitionById(@NotNull
                                                                       ImmutablePlan plan,
                                                                       long id)

getDefaultPlanRepositoryDefinition

@Nullable
public static PlanRepositoryDefinition getDefaultPlanRepositoryDefinition(@NotNull
                                                                                    ImmutablePlan plan)

isDefault

public static boolean isDefault(@NotNull
                                PlanRepositoryDefinition repositoryDefinition)

getCurrentStatus

public static String getCurrentStatus(@NotNull
                                      ImmutablePlan plan)

getMasterPlan

@NotNull
public static ImmutablePlan getMasterPlan(@NotNull
                                                   ImmutablePlan plan)

Get master plan if plan has master or passed plan otherwise.

Parameters:

plan -

Returns:

getMasterPlan

@NotNull
public static ImmutableChain getMasterPlan(@NotNull
                                                    ImmutableChain plan)

Get master plan if plan has master or passed plan otherwise.

Parameters:

plan -

Returns:

getMasterPlan

@NotNull
public static Chain getMasterPlan(@NotNull
                                           Chain plan)

Get master plan if plan has master or passed plan otherwise.

Parameters:

plan -

Returns:

getMasterPlanKey

@NotNull
public static PlanKey getMasterPlanKey(@NotNull
                                                ImmutablePlan plan)

Get planKey of master plan if plan has master or planKey of passed plan otherwise.

Parameters:

plan -

Returns:

getBranchedImmutableJob

public static ImmutableJob getBranchedImmutableJob(ImmutableChain chainBranch,
                                                   ImmutableJob masterJob)

Searches for a corresponding job in a branch.

Parameters:

chainBranch - branch where job has to be searched

masterJob - job which is to be found in a branch

Returns:

ImmutableJob or null if not found

getBranchedStage

@NotNull
public static ImmutableChainStage getBranchedStage(ImmutableChain chainBranch,
                                                            ImmutableChainStage masterStage)

getConfigObject

@Nullable
public static <T> T getConfigObject(@NotNull
                                              ImmutablePlan plan,
                                              @NotNull
                                              String key,
                                              @NotNull
                                              Class<T> clazz)

getConfigObject

@Nullable
public static <T> T getConfigObject(@NotNull
                                              BuildDefinition planDefinition,
                                              @NotNull
                                              String key,
                                              @NotNull
                                              Class<T> clazz)

getPermissionPlanId

public static long getPermissionPlanId(ImmutablePlan plan)

getMasterAndBranchesKeys

@NotNull
public static Set<PlanKey> getMasterAndBranchesKeys(@NotNull
                                                             CachedPlanManager cachedPlanManager,
                                                             @NotNull
                                                             PlanKey masterOrBranchKey)

Get keys of all branches and master plan.

Parameters:

cachedPlanManager - cachedPlanManager bean

masterOrBranchKey - key of either master plan or one of the branches in the family

Returns:

set of keys of all branches and master plan

getPlanKeysOfBranchesSharingConfiguration

@NotNull
public static Set<PlanKey> getPlanKeysOfBranchesSharingConfiguration(@NotNull
                                                                              CachedPlanManager cachedPlanManager,
                                                                              @NotNull
                                                                              PlanKey masterOrBranchKey)

Get keys of all branches (including master plan if applicable) that share the configuration. If the argumanet is a key of a master plan or any lightweight branch, the returned list contains key of the master plan and keys of all its lightweight branches. If the argument is a key of a divergent branch, the list containing that key only is returned.

Parameters:

cachedPlanManager - cachedPlanManager bean

masterOrBranchKey - key of either master plan or one of the branches in the family

Returns:

set of keys of all lightweight branches and master plan

getBranchesForJob

public static Stream<ImmutableJob> getBranchesForJob(@NotNull
                                                     CachedPlanManager cachedPlanManager,
                                                     @NotNull
                                                     ImmutableJob masterJob)

haveTheSameMaster

public static boolean haveTheSameMaster(@NotNull
                                        CachedPlanManager cachedPlanManager,
                                        @NotNull
                                        PlanKey masterOrBranchKeyA,
                                        @NotNull
                                        PlanKey masterOrBranchKeyB)

haveTheSameMaster

public static boolean haveTheSameMaster(@NotNull
                                        CachedPlanManager cachedPlanManager,
                                        @NotNull
                                        ImmutableChain masterOrBranchA,
                                        @NotNull
                                        ImmutableChain masterOrBranchB)

hasMultipleBranches

public static boolean hasMultipleBranches(@NotNull
                                          CachedPlanManager cachedPlanManager,
                                          @NotNull
                                          PlanKey planKey)

defaultRepositoryAsRootPredicate

public static Predicate<ImmutableChain> defaultRepositoryAsRootPredicate(long repositoryId)

passes chains when the default plan repository definition points to root definition with given id