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>
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescription@NotNull Capability
getCapability
(@NotNull Map<String, String[]> params) Returns a new capability given the action params map.@NotNull String
The key for the type typically lower case@NotNull String
Human readable version of the keyGet task configuration key for the capability type.@Nullable String
getExtraInfo
(@NotNull String key) Displayed after the label@NotNull String
The display label@NotNull String
getNewKeyFromLabel
(@NotNull String oldKey, @NotNull String label) From the key and label, return a new key.int
Specifies how early in the UI the type should be shownDeprecated.since 4.4com.opensymphony.xwork2.TextProvider
Deprecated.since 4.4@Nullable String
getValueDescriptionKey
(@NotNull String key, @Nullable String value) Given the key and value, show any custom description for the value@Nullable String
The action name of the list view action of this capability typeboolean
Can you rename the key for this typevoid
setTaskManager
(TaskManager taskManager) void
setTextProvider
(com.opensymphony.xwork2.TextProvider textProvider) Validate given an action params map.Methods inherited from class com.atlassian.bamboo.v2.build.agent.capability.AbstractCapabilityType
compareTo, equals, hashCode, toString, updateTasksForNewLabel
-
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
Description copied from interface:CapabilityType
The key for the type typically lower case- Returns:
-
getCapabilityTypeLabel
Description copied from interface:CapabilityType
Human readable version of the key -
getViewTypeAction
Description copied from interface:CapabilityType
The action name of the list view action of this capability type- Specified by:
getViewTypeAction
in interfaceCapabilityType
- Overrides:
getViewTypeAction
in classAbstractCapabilityType
- Returns:
-
getLabel
Description copied from interface:CapabilityType
The display label- Returns:
-
getExtraInfo
Description copied from interface:CapabilityType
Displayed after the label- 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- 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- Returns:
-
getCapabilityTypeSpecificTaskConfigurationKey
Description copied from interface:CapabilityType
Get task configuration key for the capability type. -
validate
Description copied from interface:CapabilityType
Validate given an action params map.- Returns:
- Map with errors. key = field name, value = error message
-
getCapability
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
-
getTaskManager
Deprecated.since 4.4 -
setTaskManager
-
getTextProvider
Deprecated.since 4.4 -
setTextProvider
public void setTextProvider(com.opensymphony.xwork2.TextProvider textProvider)
-