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 |
---|---|
Capability |
getCapability(Map<String,String[]> params)
Returns a new capability given the action params map
|
String |
getCapabilityTypeKey()
The key for the type typically lower case
|
String |
getCapabilityTypeLabel()
Deprecated.
since 5.5 not used - without replacement
|
String |
getExtraInfo(String key)
Displayed after the label
|
String |
getLabel(String key)
The display label
|
String |
getNewKeyFromLabel(String oldKey,
String label)
From the key and label, return a new key.
|
int |
getSortOrder()
Specifies how early in the UI the type should be shown
|
String |
getValueDescriptionKey(String key,
String value)
Given the key and value, show any custom description for the value
|
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(Buildable plan,
String oldLabel,
String newLabel)
Perform custom work when the key has been updated.
|
Map<String,String> |
validate(Map<String,String[]> params)
Validate given an action params map.
|
compareTo
int getSortOrder()
@NotNull String getCapabilityTypeKey()
@NotNull @Deprecated String getCapabilityTypeLabel()
@Nullable String getViewTypeAction()
@NotNull Map<String,String> validate(@NotNull Map<String,String[]> params)
params
- @NotNull Capability getCapability(@NotNull Map<String,String[]> params)
params
- @Nullable String getExtraInfo(@NotNull String key)
key
- @Nullable String getValueDescriptionKey(@NotNull String key, @Nullable String value)
key
- value
- boolean isAllowRename()
@NotNull String getNewKeyFromLabel(@NotNull String oldKey, @NotNull String label)
oldKey
- label
- Copyright © 2017 Atlassian Software Systems Pty Ltd. All rights reserved.