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 Summary

Constructors

Constructor and Description
BuilderCapabilityType()

Method Summary

Modifier and Type	Method and Description
Collection<BuilderCapabilityDescriptor>	getBuilderTypes()
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() Human readable version of the key
String	getCapabilityTypeSpecificTaskConfigurationKey() Get task configuration key for the capability type.
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
TaskManager	getTaskManager() Deprecated. since 4.4
com.opensymphony.xwork2.TextProvider	getTextProvider() Deprecated. since 4.4
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	setTaskManager(TaskManager taskManager)
void	setTextProvider(com.opensymphony.xwork2.TextProvider textProvider)
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.

Methods inherited from class com.atlassian.bamboo.v2.build.agent.capability.AbstractCapabilityType

compareTo, equals, hashCode, toString, updateTasksForNewLabel

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BuilderCapabilityType

public BuilderCapabilityType()

Method Detail

getSortOrder

public int getSortOrder()

Description copied from interface: CapabilityType

Specifies how early in the UI the type should be shown

Returns:

getCapabilityTypeKey

@NotNull
public String getCapabilityTypeKey()

Description copied from interface: CapabilityType

The key for the type typically lower case

Returns:

getCapabilityTypeLabel

@NotNull
public String getCapabilityTypeLabel()

Description copied from interface: CapabilityType

Human readable version of the key

Returns:

getViewTypeAction

@Nullable
public 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 String getLabel(@NotNull
                                String key)

Description copied from interface: CapabilityType

The display label

Returns:

getExtraInfo

@Nullable
public String getExtraInfo(@NotNull
                                     String key)

Description copied from interface: CapabilityType

Displayed after the label

Returns:

getValueDescriptionKey

@Nullable
public String getValueDescriptionKey(@NotNull
                                               String key,
                                               @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 String getNewKeyFromLabel(@NotNull
                                          String oldKey,
                                          @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:

updatePlanForNewLabel

public void updatePlanForNewLabel(@NotNull
                                  Buildable plan,
                                  @NotNull
                                  String oldLabel,
                                  @NotNull
                                  String newLabel)

Description copied from interface: CapabilityType

Perform custom work when the key has been updated.

Specified by:

updatePlanForNewLabel in interface CapabilityType

Overrides:

updatePlanForNewLabel in class AbstractCapabilityType

oldLabel - label to replace

newLabel - new label

getCapabilityTypeSpecificTaskConfigurationKey

public String getCapabilityTypeSpecificTaskConfigurationKey()

Description copied from interface: CapabilityType

Get task configuration key for the capability type.

validate

@NotNull
public Map<String,String> validate(@NotNull
                                            Map<String,String[]> params)

Description copied from interface: CapabilityType

Validate given an action params map.

Returns:

Map with errors. key = field name, value = error message

getCapability

@NotNull
public Capability getCapability(@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 com.opensymphony.xwork2.TextProvider getTextProvider()

Deprecated. since 4.4

setTextProvider

public void setTextProvider(com.opensymphony.xwork2.TextProvider textProvider)