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

Class AbstractMultipleExecutableCapabilityTypeModule

java.lang.Object

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

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

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

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

All Implemented Interfaces:

InitablePluginModule, BambooPluginModule, CapabilityDefaultsHelper, CapabilityType, CapabilityTypeModule, com.atlassian.core.i18n.I18nTextProvider, Comparable<CapabilityType>

Direct Known Subclasses:

GitCapabilityTypeModule

public abstract class AbstractMultipleExecutableCapabilityTypeModule
extends AbstractExecutableCapabilityTypeModule

Field Summary

Fields inherited from class com.atlassian.bamboo.v2.build.agent.capability.AbstractExecutableCapabilityTypeModule

AGENT_CAPABILITY_TYPE_PREFIX

Fields inherited from interface com.atlassian.bamboo.v2.build.agent.capability.CapabilityDefaultsHelper

CAPABILITY_AGENT_ENVIRONMENT_PREFIX, CAPABILITY_BUILDER_PREFIX, CAPABILITY_BUILDER_TYPE

Constructor Summary

Constructors

Constructor	Description
AbstractMultipleExecutableCapabilityTypeModule()

Method Summary

Modifier and Type	Method	Description
abstract List<String>	getAdditionalCapabilityKeys()
@NotNull Capability	getCapability(@NotNull Map<String,String[]> params)	Returns a new capability given the action params map
abstract String	getCapabilityKindUndefinedKey()
String	getExecutableDescription(String key)
String	getExecutableKey()
abstract String	getExecutableKindKey()
Map<String,String>	getExecutableTypes()
@NotNull String	getLabel(@NotNull String key)	The display label
String	getValueDescriptionKey(@NotNull String key, @Nullable String value)	Given the key and value, show any custom description for the value
@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.AbstractExecutableCapabilityTypeModule

addDefaultCapabilities, getCapabilityUndefinedKey, getDefaultWindowPaths, getExecutableFilename, getMandatoryCapabilityKey, getParamValue, getText, getText, getText, getTextProvider, setTextProvider

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

getCapabilityTypeKey, getCapabilityTypeLabel, getEditHtml, getExtraInfo, getNewKeyFromLabel, getSortOrder, init, isAllowRename, setTemplateRenderer

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, getViewTypeAction, updatePlanForNewLabel

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Detail

AbstractMultipleExecutableCapabilityTypeModule

public AbstractMultipleExecutableCapabilityTypeModule()

Method Detail

getExecutableKindKey

public abstract String getExecutableKindKey()

getAdditionalCapabilityKeys

public abstract List<String> getAdditionalCapabilityKeys()

getCapabilityKindUndefinedKey

public abstract String getCapabilityKindUndefinedKey()

getLabel

@NotNull
public @NotNull String getLabel(@NotNull
                                @NotNull String key)

Description copied from interface: CapabilityType

The display label

Specified by:

getLabel in interface CapabilityType

Overrides:

getLabel in class AbstractExecutableCapabilityTypeModule

Returns:

getExecutableKey

public String getExecutableKey()

Specified by:

getExecutableKey in class AbstractExecutableCapabilityTypeModule

getExecutableTypes

public Map<String,String> getExecutableTypes()

getExecutableDescription

public String getExecutableDescription(String key)

getValueDescriptionKey

public 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

Overrides:

getValueDescriptionKey in class AbstractCapabilityTypeModule

Returns:

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

Overrides:

validate in class AbstractExecutableCapabilityTypeModule

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

Overrides:

getCapability in class AbstractExecutableCapabilityTypeModule