com.atlassian.bamboo.plan.branch

Interface ChainBranchManager

public interface ChainBranchManager

Method Summary

Methods

Modifier and Type	Method and Description
int	getBranchCount(ImmutablePlan plan) Returns the number of branches the given plan has
List<ChainBranch>	getBranchesForChain(ImmutableChain chain) Get all feature branches associated with the given chain
Collection<Job>	getBranchesForJob(Job job)
List<ChainBranchIdentifier>	getBranchIdentifiersForChain(PlanIdentifier chain) Get all feature branches associated with the given chain, however on pulls up minimal details about each branch.
ChainBranchIdentifier	getBranchWithName(ImmutableChain masterPlan, String branchName) Returns ChainBranchIdentifier of ChainBranch with given master Chain and name.
long	getNextBranchKeyNumber(ImmutablePlan chain) Retrieving suggested number for next branch key in given chain.
Set<Long>	getPlansWithBranches() Returns a list of plans that currently have branches
void	handleVcsBranchDeletedOfPlanBranch(ImmutableChain chainBranch) If the passed in chain is a plan branch with a VCS branch this will mark that VCS branch as deleted and disable the plan branch.
boolean	hasBranches(Plan plan) Returns whether or not the given plan has any branches
boolean	isPlanBranchNameConflicting(ImmutableChain masterPlan, long chainBranchIdToIgnore, String branchName) Verifies whether a ChainBranch name is unique with a given master Chain
void	updateNextBranchKeyNumber(ImmutablePlan chain, long number) Set suggested number for next branch key in given chain

Method Detail

getBranchesForChain

@NotNull
List<ChainBranch> getBranchesForChain(@NotNull
                                            ImmutableChain chain)

Get all feature branches associated with the given chain

Parameters:

chain - - the master

Returns:

List ChainBranchs associated with the given chain.

getBranchIdentifiersForChain

@NotNull
List<ChainBranchIdentifier> getBranchIdentifiersForChain(@NotNull
                                                               PlanIdentifier chain)

Get all feature branches associated with the given chain, however on pulls up minimal details about each branch.

Parameters:

chain - - the master

Returns:

List ChainBranchIdentifier for branches associated with the given Chain.

hasBranches

boolean hasBranches(@NotNull
                  Plan plan)

Returns whether or not the given plan has any branches

Parameters:

plan - to check for branches for

Returns:

true if branches exist of the plan

getBranchCount

int getBranchCount(@NotNull
                 ImmutablePlan plan)

Returns the number of branches the given plan has

Parameters:

plan - to check for branches for

Returns:

number of branches for the plan

getPlansWithBranches

@NotNull
Set<Long> getPlansWithBranches()

Returns a list of plans that currently have branches

Returns:

a list of plan ids of the plans with branches.

isPlanBranchNameConflicting

boolean isPlanBranchNameConflicting(ImmutableChain masterPlan,
                                  long chainBranchIdToIgnore,
                                  String branchName)

Verifies whether a ChainBranch name is unique with a given master Chain

Parameters:

masterPlan - the master chain within which the name has to be unique

chainBranchIdToIgnore - the id of the ChainBranch that has to be ignored during lookup (when you're saving a ChainBranch, you should supply its id here)

branchName - displayed name of the ChainBranch inside the master's plan

Returns:

true if the name is in conflict

Since:

4.0

getBranchWithName

@Nullable
ChainBranchIdentifier getBranchWithName(ImmutableChain masterPlan,
                                               String branchName)

Returns ChainBranchIdentifier of ChainBranch with given master Chain and name.

Parameters:

masterPlan -

branchName -

Returns:

ChainBranchIdentifier or null if no such branch exists

Since:

4.2

handleVcsBranchDeletedOfPlanBranch

void handleVcsBranchDeletedOfPlanBranch(ImmutableChain chainBranch)

If the passed in chain is a plan branch with a VCS branch this will mark that VCS branch as deleted and disable the plan branch. If the passed in plan branch does not have a primary repository which supports branching then this method w ill have no effect on the plan branch.

Parameters:

chainBranch - the plan branch of which a VCS branch was deleted

getBranchesForJob

Collection<Job> getBranchesForJob(Job job)

getNextBranchKeyNumber

long getNextBranchKeyNumber(ImmutablePlan chain)

Retrieving suggested number for next branch key in given chain. If it's first branch it will return 0.

Parameters:

chain -

Returns:

updateNextBranchKeyNumber

void updateNextBranchKeyNumber(ImmutablePlan chain,
                             long number)

Set suggested number for next branch key in given chain

Parameters:

chain -

number -