Package com.atlassian.bamboo.ww2.beans
Interface DecoratedNavObjectFactory
- All Known Implementing Classes:
DecoratedNavObjectFactoryImpl
public interface DecoratedNavObjectFactory
-
Method Summary
Modifier and TypeMethodDescription@Nullable DecoratedPlan
decoratePlan
(@NotNull ImmutablePlan plan) Decorate plan@NotNull DecoratedResult
decorateResult
(ResultsSummary summary) Gets the decorated result for the given result summary, including the full object hierarchy around it, such as parent if it is a job summary, and plan.com.google.common.collect.ImmutableList<DecoratedPlan>
getDecoratedChainBranches
(@NotNull DecoratedPlan master) Deprecated.since 6.5 causes explosive cache refreshcom.google.common.collect.ImmutableList<DecoratedPlan.DecoratedPlanBranchGist>
getDecoratedChainBranchIdentifiers
(@NotNull DecoratedPlan master) Returns a list of branches associated with the master.@NotNull DecoratedPlan
getDecoratedPlan
(ChainResultsSummary resultSummary) Gets the decorated plan for the given result summary.getStageDecorator
(@NotNull DecoratedPlan parent) Return a function that could be used to decorate stagesgetStageResultDecorator
(@NotNull DecoratedPlan parent) @Nullable String
getSubstitutedBranchName
(@NotNull ImmutableChain chain) Gets the branch name from the default repository if the chain has one.
-
Method Details
-
decoratePlan
Decorate plan- Parameters:
plan
-Plan
to be decorated- Returns:
DecoratedPlan
object
-
getStageDecorator
Function<ImmutableChainStage,DecoratedStage> getStageDecorator(@NotNull @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
-
getStageResultDecorator
Function<ChainStageResult,DecoratedStage> getStageResultDecorator(@NotNull @NotNull DecoratedPlan parent) -
getDecoratedChainBranches
@Deprecated com.google.common.collect.ImmutableList<DecoratedPlan> getDecoratedChainBranches(@NotNull @NotNull DecoratedPlan master) Deprecated.since 6.5 causes explosive cache refreshReturns a list of branches associated with the master.- Returns:
- list of decorated branches for the Nav Object
-
getDecoratedChainBranchIdentifiers
com.google.common.collect.ImmutableList<DecoratedPlan.DecoratedPlanBranchGist> getDecoratedChainBranchIdentifiers(@NotNull @NotNull DecoratedPlan master) Returns a list of branches associated with the master.- Returns:
- list of decorated branches for the Nav Object
-
getDecoratedPlan
Gets the decorated plan for the given result summary. If possible will look to the plan cache for the plan.- Parameters:
resultSummary
- a chain result summary.- Returns:
- Decorated Plan for the given result summary's plan
- Throws:
IllegalStateException
- if the plan cannot be found
-
getSubstitutedBranchName
Gets the branch name from the default repository if the chain has one. Will perform variable substitution on the branch name- Returns:
- Branch name of the default repository after substitution, if one exists.
-
decorateResult
Gets the decorated result for the given result summary, including the full object hierarchy around it, such as parent if it is a job summary, and plan.
-