Package 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	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 @NotNull ImmutableChainStage	getBranchedStage(ImmutableChain chainBranch, ImmutableChainStage masterStage)
static Stream<ImmutableJob>	getBranchesForJob(@NotNull CachedPlanManager cachedPlanManager, @NotNull ImmutableJob masterJob)
static <T> T	getConfigObject(@NotNull BuildDefinition planDefinition, @NotNull String key, @NotNull Class<T> clazz)
static <T> T	getConfigObject(@NotNull ImmutablePlan plan, @NotNull String key, @NotNull Class<T> clazz)
static String	getCurrentStatus(@NotNull ImmutablePlan plan)
static @Nullable PlanRepositoryDefinition	getDefaultPlanRepositoryDefinition(@NotNull ImmutablePlan plan)
static @NotNull Set<PlanKey>	getMasterAndBranchesKeys(@NotNull CachedPlanManager cachedPlanManager, @NotNull PlanKey masterOrBranchKey)	Get keys of all branches and master plan.
static @NotNull Chain	getMasterPlan(@NotNull Chain plan)	Get master plan if plan has master or passed plan otherwise.
static @NotNull ImmutableChain	getMasterPlan(@NotNull ImmutableChain plan)	Get master plan if plan has master or passed plan otherwise.
static @NotNull ImmutablePlan	getMasterPlan(@NotNull ImmutablePlan plan)	Get master plan if plan has master or passed plan otherwise.
static @NotNull PlanKey	getMasterPlanKey(@NotNull ImmutablePlan plan)	Get planKey of master plan if plan has master or planKey of passed plan otherwise.
static long	getPermissionPlanId(ImmutablePlan plan)
static @NotNull Set<PlanKey>	getPlanKeysOfBranchesSharingConfiguration(@NotNull CachedPlanManager cachedPlanManager, @NotNull PlanKey masterOrBranchKey)	Get keys of all branches (including master plan if applicable) that share the configuration.
static PlanRepositoryDefinition	getPlanRepositoryDefinitionById(@NotNull ImmutablePlan plan, long id)
static @NotNull LinkedHashMap<Long,PlanRepositoryDefinition>	getPlanRepositoryDefinitionMap(@NotNull ImmutablePlan plan)
static List<PlanRepositoryDefinition>	getPlanRepositoryDefinitions(@NotNull ImmutablePlan plan)
static List<PlanRepositoryDefinition>	getPlanRepositoryDefinitionsByType(@NotNull ImmutablePlan plan, @NotNull String pluginKey)
static boolean	hasMultipleBranches(@NotNull CachedPlanManager cachedPlanManager, @NotNull PlanKey planKey)
static boolean	haveTheSameMaster(@NotNull CachedPlanManager cachedPlanManager, @NotNull PlanKey masterOrBranchKeyA, @NotNull PlanKey masterOrBranchKeyB)
static boolean	haveTheSameMaster(@NotNull ImmutableChain masterOrBranchA, @NotNull ImmutableChain masterOrBranchB)
static boolean	isDefault(@NotNull PlanRepositoryDefinition repositoryDefinition)
static boolean	isDivergentBranch(@NotNull ImmutableChain chain)
static boolean	isDivergentBranch(@NotNull 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
                                        @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
                                        @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 @NotNull LinkedHashMap<Long,PlanRepositoryDefinition> getPlanRepositoryDefinitionMap(@NotNull
                                                                                                         @NotNull ImmutablePlan plan)

getPlanRepositoryDefinitions

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

getPlanRepositoryDefinitionsByType

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

getPlanRepositoryDefinitionById

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

getDefaultPlanRepositoryDefinition

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

isDefault

public static boolean isDefault(@NotNull
                                @NotNull PlanRepositoryDefinition repositoryDefinition)

getCurrentStatus

public static String getCurrentStatus(@NotNull
                                      @NotNull ImmutablePlan plan)

getMasterPlan

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

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

Parameters:

plan -

Returns:

getMasterPlan

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

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

Parameters:

plan -

Returns:

getMasterPlan

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

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

Parameters:

plan -

Returns:

getMasterPlanKey

@NotNull
public static @NotNull PlanKey getMasterPlanKey(@NotNull
                                                @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 @NotNull ImmutableChainStage getBranchedStage(ImmutableChain chainBranch,
                                                            ImmutableChainStage masterStage)

getConfigObject

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

getConfigObject

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

getPermissionPlanId

public static long getPermissionPlanId(ImmutablePlan plan)

getMasterAndBranchesKeys

@NotNull
public static @NotNull Set<PlanKey> getMasterAndBranchesKeys(@NotNull
                                                             @NotNull CachedPlanManager cachedPlanManager,
                                                             @NotNull
                                                             @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 @NotNull Set<PlanKey> getPlanKeysOfBranchesSharingConfiguration(@NotNull
                                                                              @NotNull CachedPlanManager cachedPlanManager,
                                                                              @NotNull
                                                                              @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
                                                     @NotNull CachedPlanManager cachedPlanManager,
                                                     @NotNull
                                                     @NotNull ImmutableJob masterJob)

haveTheSameMaster

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

haveTheSameMaster

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

hasMultipleBranches

public static boolean hasMultipleBranches(@NotNull
                                          @NotNull CachedPlanManager cachedPlanManager,
                                          @NotNull
                                          @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