Package 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	Description
AgentEnvironmentCapabilityType()

Method Summary

Modifier and Type	Method	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
@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
boolean	isAllowRename()	Can you rename the key for this type
@NotNull Map<String,String>	validate(@NotNull 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 @NotNull 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 @NotNull String getCapabilityTypeLabel()

Description copied from interface: CapabilityType

Human readable version of the key

Specified by:

getCapabilityTypeLabel in interface CapabilityType

validate

@NotNull
public @NotNull Map<String,String> validate(@NotNull
                                                  @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 @NotNull Capability getCapability(@NotNull
                                         @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 @NotNull String getLabel(@NotNull
                                @NotNull String key)

Description copied from interface: CapabilityType

The display label

Specified by:

getLabel in interface CapabilityType

Returns:

getExtraInfo

@Nullable
public @Nullable String getExtraInfo(@NotNull
                                     @NotNull String key)

Description copied from interface: CapabilityType

Displayed after the label

Specified by:

getExtraInfo in interface CapabilityType

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

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 @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

Specified by:

getNewKeyFromLabel in interface CapabilityType

Returns: