Package com.atlassian.bamboo.v2.build.agent.capability

Class BuilderCapabilityType

java.lang.Object
com.atlassian.bamboo.v2.build.agent.capability.AbstractCapabilityType
com.atlassian.bamboo.v2.build.agent.capability.BuilderCapabilityType
All Implemented Interfaces:
CapabilityType, Comparable<CapabilityType>
public class BuilderCapabilityType extends AbstractCapabilityType

  • Constructor Details

    • BuilderCapabilityType

      public BuilderCapabilityType()

  • Method Details

    • getSortOrder

      public int getSortOrder()
      Description copied from interface: CapabilityType
      Specifies how early in the UI the type should be shown
      Returns:

    • getCapabilityTypeKey

      @NotNull public @NotNull String getCapabilityTypeKey()
      Description copied from interface: CapabilityType
      The key for the type typically lower case
      Returns:

    • getCapabilityTypeLabel

      @NotNull public @NotNull String getCapabilityTypeLabel()
      Description copied from interface: CapabilityType
      Human readable version of the key

    • getViewTypeAction

      @Nullable public @Nullable String getViewTypeAction()
      Description copied from interface: CapabilityType
      The action name of the list view action of this capability type
      Specified by:
      getViewTypeAction in interface CapabilityType
      Overrides:
      getViewTypeAction in class AbstractCapabilityType
      Returns:

    • getLabel

      @NotNull public @NotNull String getLabel(@NotNull @NotNull String key)
      Description copied from interface: CapabilityType
      The display label
      Parameters:
      key -
      Returns:

    • getExtraInfo

      @Nullable public @Nullable String getExtraInfo(@NotNull @NotNull String key)
      Description copied from interface: CapabilityType
      Displayed after the label
      Parameters:
      key -
      Returns:

    • getValueDescriptionKey

      @Nullable public @Nullable String getValueDescriptionKey(@NotNull @NotNull String key, @Nullable @Nullable String value)
      Description copied from interface: CapabilityType
      Given the key and value, show any custom description for the value
      Parameters:
      key -
      value -
      Returns:

    • isAllowRename

      public boolean isAllowRename()
      Description copied from interface: CapabilityType
      Can you rename the key for this type
      Returns:

    • getNewKeyFromLabel

      @NotNull public @NotNull String getNewKeyFromLabel(@NotNull @NotNull String oldKey, @NotNull @NotNull String label)
      Description copied from interface: CapabilityType
      From the key and label, return a new key. This is used in the rename process
      Parameters:
      oldKey -
      label -
      Returns:

    • getCapabilityTypeSpecificTaskConfigurationKey

      public String getCapabilityTypeSpecificTaskConfigurationKey()
      Description copied from interface: CapabilityType
      Get task configuration key for the capability type.

    • validate

      @NotNull public @NotNull Map<String,String> validate(@NotNull @NotNull Map<String,String[]> params)
      Description copied from interface: CapabilityType
      Validate given an action params map.
      Parameters:
      params -
      Returns:
      Map with errors. key = field name, value = error message

    • getCapability

      @NotNull public @NotNull Capability getCapability(@NotNull @NotNull Map<String,String[]> params)
      Returns a new capability given the action params map. For builders that are not "LabelPathMapConfigurable" label and path are not fetched from action params but rather from a call to Builder#addDefaultLabelPathMaps.
      Parameters:
      params - action params
      Returns:
      new capability

    • getBuilderTypes

      public Collection<BuilderCapabilityDescriptor> getBuilderTypes()

    • getTaskManager

      @Deprecated public TaskManager getTaskManager()
      Deprecated.
      since 4.4

    • setTaskManager

      public void setTaskManager(TaskManager taskManager)

    • getTextProvider

      @Deprecated public org.apache.struts2.text.TextProvider getTextProvider()
      Deprecated.
      since 4.4

    • setTextProvider

      public void setTextProvider(org.apache.struts2.text.TextProvider textProvider)