Interface DecoratedNavObjectFactory

All Known Implementing Classes:
DecoratedNavObjectFactoryImpl

public interface DecoratedNavObjectFactory
  • Method Details

    • decoratePlan

      @Nullable @Nullable DecoratedPlan decoratePlan(@NotNull @NotNull ImmutablePlan plan)
      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 refresh
      Returns 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

      @NotNull @NotNull DecoratedPlan getDecoratedPlan(ChainResultsSummary resultSummary)
      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

      @Nullable @Nullable String getSubstitutedBranchName(@NotNull @NotNull ImmutableChain chain)
      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

      @NotNull @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.