public interface CapabilityType extends Comparable<CapabilityType>
A CapabilityType module may optionally implement the CapabilityDefaultsHelper
interface for server- and agent-side capability auto detection.
Modifier and Type | Method and Description |
---|---|
@NotNull Capability |
getCapability(@NotNull Map<String,String[]> params)
Returns a new capability given the action params map
|
@NotNull String |
getCapabilityTypeKey()
The key for the type typically lower case
|
@NotNull String |
getCapabilityTypeLabel()
Human readable version of the key
|
default String |
getCapabilityTypeSpecificTaskConfigurationKey()
Get task configuration key for the capability type.
|
@Nullable String |
getExtraInfo(@NotNull String key)
Displayed after the label
|
@NotNull String |
getLabel(@NotNull String key)
The display label
|
@NotNull String |
getNewKeyFromLabel(@NotNull String oldKey,
@NotNull String label)
From the key and label, return a new key.
|
int |
getSortOrder()
Specifies how early in the UI the type should be shown
|
@Nullable String |
getValueDescriptionKey(@NotNull String key,
@Nullable String value)
Given the key and value, show any custom description for the value
|
@Nullable String |
getViewTypeAction()
The action name of the list view action of this capability type
|
boolean |
isAllowRename()
Can you rename the key for this type
|
void |
updatePlanForNewLabel(@NotNull Buildable plan,
@NotNull String oldLabel,
@NotNull String newLabel)
Deprecated.
since 6.5 it doesn't work, modification of build definition requires use of manager.
|
@NotNull Map<String,String> |
validate(@NotNull Map<String,String[]> params)
Validate given an action params map.
|
compareTo
int getSortOrder()
@NotNull @NotNull String getCapabilityTypeKey()
@NotNull @NotNull String getCapabilityTypeLabel()
@Nullable @Nullable String getViewTypeAction()
@NotNull @NotNull Map<String,String> validate(@NotNull @NotNull Map<String,String[]> params)
params
- @NotNull @NotNull Capability getCapability(@NotNull @NotNull Map<String,String[]> params)
params
- @NotNull @NotNull String getLabel(@NotNull @NotNull String key)
key
- @Nullable @Nullable String getExtraInfo(@NotNull @NotNull String key)
key
- @Nullable @Nullable String getValueDescriptionKey(@NotNull @NotNull String key, @Nullable @Nullable String value)
key
- value
- boolean isAllowRename()
@NotNull @NotNull String getNewKeyFromLabel(@NotNull @NotNull String oldKey, @NotNull @NotNull String label)
oldKey
- label
- default String getCapabilityTypeSpecificTaskConfigurationKey()
@Deprecated void updatePlanForNewLabel(@NotNull @NotNull Buildable plan, @NotNull @NotNull String oldLabel, @NotNull @NotNull String newLabel)
plan
- oldLabel
- label to replacenewLabel
- new labelCopyright © 2022 Atlassian Software Systems Pty Ltd. All rights reserved.