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

java.lang.Object
  com.atlassian.bamboo.v2.build.agent.capability.CapabilityHelper

public class CapabilityHelper
extends java.lang.Object

Class that helps the display and configuration of capabilities and requirements

Field Summary

protected java.util.Map<java.lang.String,CapabilityType>

builtinCapabilityTypes

Constructor Summary

CapabilityHelper(com.atlassian.plugin.PluginAccessor pluginAccessor)

Method Summary

com.opensymphony.webwork.dispatcher.json.JSONObject	buildCapabilityJsonObject(Capability capability) Build JSON object from capability.
java.lang.String	getCapabilityExtraInfo(java.lang.String key) tries to figure out the extra information of a capability based on the key.
java.lang.String	getCapabilityLabel(java.lang.String key) Tries to figure out the capability Label.
java.lang.String	getCapabilityTabForKey(java.lang.String key) Get the jquery represnetation of the capability to pick the correct tab to navigate to.
java.lang.String	getCapabilityType(java.lang.String key)
CapabilityType	getCapabilityTypeFromKey(java.lang.String key)
CapabilityType	getCapabilityTypeFromTypeString(java.lang.String capabilityTypeKey)
java.util.List<CapabilityType>	getCapabilityTypes()
java.util.Collection<BuilderCapabilityDescriptor>	getFilteredBuildersFromTypeString(java.lang.String capabilityTypeKey, java.lang.String capabilityPrefix)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

builtinCapabilityTypes

protected final java.util.Map<java.lang.String,CapabilityType> builtinCapabilityTypes

Constructor Detail

CapabilityHelper

public CapabilityHelper(com.atlassian.plugin.PluginAccessor pluginAccessor)

Method Detail

buildCapabilityJsonObject

@NotNull
public com.opensymphony.webwork.dispatcher.json.JSONObject buildCapabilityJsonObject(@NotNull
                                                                                             Capability capability)
                                                                              throws com.opensymphony.webwork.dispatcher.json.JSONException

Build JSON object from capability.

Parameters:

capability - Capability

Returns:

JSON object

Throws:

com.opensymphony.webwork.dispatcher.json.JSONException - When an error occurs during creation of JSON object

getCapabilityTypeFromTypeString

@Nullable
public CapabilityType getCapabilityTypeFromTypeString(java.lang.String capabilityTypeKey)

getFilteredBuildersFromTypeString

public java.util.Collection<BuilderCapabilityDescriptor> getFilteredBuildersFromTypeString(java.lang.String capabilityTypeKey,
                                                                                           java.lang.String capabilityPrefix)

getCapabilityTypeFromKey

@NotNull
public CapabilityType getCapabilityTypeFromKey(java.lang.String key)

getCapabilityType

public java.lang.String getCapabilityType(java.lang.String key)

getCapabilityLabel

@NotNull
public java.lang.String getCapabilityLabel(java.lang.String key)

Tries to figure out the capability Label. If it fails it will return the original key.

Parameters:

key - to find the label for

Returns:

the label for the capability (or the original passed in key, if it fails)

getCapabilityExtraInfo

@Nullable
public java.lang.String getCapabilityExtraInfo(java.lang.String key)

tries to figure out the extra information of a capability based on the key. If it fails it returns null.

Parameters:

key - of the capability

Returns:

the extra information (pretty) for that capability.

getCapabilityTabForKey

public java.lang.String getCapabilityTabForKey(java.lang.String key)

Get the jquery represnetation of the capability to pick the correct tab to navigate to.

Parameters:

key - to replace (usually the Label of the capability)

Returns:

jquery representation of the key.

getCapabilityTypes

public java.util.List<CapabilityType> getCapabilityTypes()