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

Class AgentEnvironmentCapabilityType

java.lang.Object

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

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

All Implemented Interfaces:

CapabilityType, ReadOnlyCapabilityType, Comparable<CapabilityType>

public class AgentEnvironmentCapabilityType
extends AbstractCapabilityType
implements ReadOnlyCapabilityType

A capability type tied to the environment in which an agent runs.

Constructor Summary

Constructors

Constructor and Description
AgentEnvironmentCapabilityType()

Method Summary

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() Human readable version of the key
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
boolean	isAllowRename() Can you rename the key for this type
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, getViewTypeAction, hashCode, toString, updatePlanForNewLabel, updateTasksForNewLabel

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.bamboo.v2.build.agent.capability.CapabilityType

getCapabilityTypeSpecificTaskConfigurationKey

Constructor Detail

AgentEnvironmentCapabilityType

public AgentEnvironmentCapabilityType()

Method Detail

getSortOrder

public int getSortOrder()

Description copied from interface: CapabilityType

Specifies how early in the UI the type should be shown

Specified by:

getSortOrder in interface CapabilityType

Returns:

getCapabilityTypeKey

@NotNull
public String getCapabilityTypeKey()

Description copied from interface: CapabilityType

The key for the type typically lower case

Specified by:

getCapabilityTypeKey in interface CapabilityType

Returns:

getCapabilityTypeLabel

@NotNull
public String getCapabilityTypeLabel()

Description copied from interface: CapabilityType

Human readable version of the key

Specified by:

getCapabilityTypeLabel in interface CapabilityType

validate

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

Description copied from interface: CapabilityType

Validate given an action params map.

Specified by:

validate in interface CapabilityType

Returns:

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

getCapability

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

Description copied from interface: CapabilityType

Returns a new capability given the action params map

Specified by:

getCapability in interface CapabilityType

getLabel

@NotNull
public String getLabel(@NotNull
                                String key)

Description copied from interface: CapabilityType

The display label

Specified by:

getLabel in interface CapabilityType

Returns:

getExtraInfo

@Nullable
public String getExtraInfo(@NotNull
                                     String key)

Description copied from interface: CapabilityType

Displayed after the label

Specified by:

getExtraInfo in interface CapabilityType

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

Specified by:

getValueDescriptionKey in interface CapabilityType

Returns:

isAllowRename

public boolean isAllowRename()

Description copied from interface: CapabilityType

Can you rename the key for this type

Specified by:

isAllowRename in interface CapabilityType

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

Specified by:

getNewKeyFromLabel in interface CapabilityType

Returns: