com.atlassian.bamboo.ww2.beans
Interface DecoratedNavObjectFactory

All Known Implementing Classes:

DecoratedNavObjectFactoryImpl

public interface DecoratedNavObjectFactory

Method Summary

DecoratedPlan	decoratePlan(ImmutablePlan plan) Decorate plan
com.google.common.collect.ImmutableList<DecoratedPlan>	getDecoratedChainBranches(DecoratedPlan master) Returns a list of branches associated with the master.
DecoratedPlan	getDecoratedPlan(ResultsSummary resultSummary) Gets the decorated plan for the given result summary.
com.google.common.base.Function<ImmutableChainStage,DecoratedStage>	getStageDecorator(DecoratedPlan parent) Return a function that could be used to decorate stages
java.lang.String	getSubstitutedBranchName(ImmutableChain chain) Gets the branch name from the default repository if the chain has one.

Method Detail

decoratePlan

@Nullable
DecoratedPlan decoratePlan(@NotNull
                                    ImmutablePlan plan)

Decorate plan

Parameters:

plan - Plan to be decorated

Returns:

DecoratedPlan object

getStageDecorator

com.google.common.base.Function<ImmutableChainStage,DecoratedStage> getStageDecorator(@NotNull
                                                                                      DecoratedPlan parent)

Return a function that could be used to decorate stages

Parameters:

parent - DecoratedPlan object that was created from a chain

Returns:

function object

getDecoratedChainBranches

com.google.common.collect.ImmutableList<DecoratedPlan> getDecoratedChainBranches(@NotNull
                                                                                 DecoratedPlan master)

Returns a list of branches associated with the master.

Parameters:

master -

Returns:

list of decorated branches for the Nav Object

getDecoratedPlan

@Nullable
DecoratedPlan getDecoratedPlan(ResultsSummary resultSummary)

Gets the decorated plan for the given result summary. If possible will look to the plan cache for the plan.

Parameters:

resultSummary -

Returns:

Decorated Plan for the given result summary's plan

getSubstitutedBranchName

@Nullable
java.lang.String getSubstitutedBranchName(@NotNull
                                                   ImmutableChain chain)

Gets the branch name from the default repository if the chain has one. Will perform variable substitution on the branch name

Parameters:

chain -

Returns:

Branch name of the default repository after substitution, if one exists.