Package com.atlassian.bamboo.build.creation

Interface PlanConfigHelper

All Known Implementing Classes:
BuildTriggerConditionConfigHelper, WebRepositoryConfigHelper
public interface PlanConfigHelper
A generic interface to perform manipulations to the Plan Configuration (BuildConfiguration)

  • Method Details

    • addDefaultsToConfig

      void addDefaultsToConfig(@NotNull @NotNull BuildConfiguration buildConfiguration)
      Adds default values for all possible selections, esp preparing for display on the UI
      Parameters:
      buildConfiguration - - to add defaults to

    • validateConfig

      void validateConfig(@NotNull @NotNull com.atlassian.struts.ValidationAware validationAware, @NotNull @NotNull BuildConfiguration buildConfiguration)
      Validates the configuration for a plan. Adds any errors to the validationAware object
      Parameters:
      validationAware - - normally the action calling this
      buildConfiguration - - the configuration to validate

    • validateConfig

      @Deprecated void validateConfig(@NotNull com.opensymphony.xwork.ValidationAware validationAware, @NotNull @NotNull BuildConfiguration buildConfiguration)
      Deprecated.
      since 5.1 use validateConfig(com.atlassian.struts.ValidationAware, BuildConfiguration)
      Validates the configuration for a plan. Adds any errors to the validationAware object
      Parameters:
      validationAware - - normally the action calling this
      buildConfiguration - - the configuration to validate

    • prepareConfig

      void prepareConfig(@NotNull @NotNull BuildConfiguration buildConfiguration)
      Prepare the build configuration for validation. Performs required manual manipulations on the build config.
      Parameters:
      buildConfiguration - to manipulate

    • cleanConfig

      void cleanConfig(@NotNull @NotNull BuildConfiguration buildConfiguration)
      Cleans out any data from the build config, not required by the selected option.
      Parameters:
      buildConfiguration - - to clean

    • performPostActionsOnConfig

      void performPostActionsOnConfig(@NotNull @NotNull BuildConfiguration buildConfiguration, @NotNull @NotNull ImmutablePlan plan)
      Performs any miscellaneous actions required before saving the plan. Is aware of the currently selected option.
      Parameters:
      buildConfiguration - - of the current configuration
      plan - - the current plan