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

java.lang.Object
  extended by com.atlassian.bamboo.v2.build.agent.capability.AbstractCapabilityType
      extended by com.atlassian.bamboo.v2.build.agent.capability.BuilderCapabilityType
All Implemented Interfaces:
CapabilityType, java.lang.Comparable<CapabilityType>

public class BuilderCapabilityType
extends AbstractCapabilityType


Constructor Summary
BuilderCapabilityType()
           
 
Method Summary
 BuilderManager getBuilderManager()
           
 java.util.Collection<Builder> getBuilderTypes()
           
 Capability getCapability(java.util.Map<java.lang.String,java.lang.String[]> params)
          Returns a new capability given the action params map
 java.lang.String getCapabilityTypeKey()
          The key for the type typically lower case
 java.lang.String getCapabilityTypeLabel()
          Human readable version of the key
 java.lang.String getExtraInfo(java.lang.String key)
          Displayed after the label
 java.lang.String getLabel(java.lang.String key)
          The display label
 java.lang.String getNewKeyFromLabel(java.lang.String oldKey, java.lang.String label)
          From the key and label, return a new key.
 int getSortOrder()
          Specifies how early in the UI the type should be shown
 java.lang.String getValueDescriptionKey(java.lang.String key, java.lang.String value)
          Given the key and value, show any custom description for the value
 java.lang.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 setBuilderManager(BuilderManager builderManager)
           
 void updatePlanForNewLabel(Build plan, java.lang.String label)
          Perform custom work when the key has been updated.
 java.util.Map<java.lang.String,java.lang.String> validate(java.util.Map<java.lang.String,java.lang.String[]> params)
          Validate given an action params map.
 
Methods inherited from class com.atlassian.bamboo.v2.build.agent.capability.AbstractCapabilityType
compareTo, equals, hashCode, toString
 
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 java.lang.String getCapabilityTypeKey()
Description copied from interface: CapabilityType
The key for the type typically lower case

Returns:

getCapabilityTypeLabel

@NotNull
public java.lang.String getCapabilityTypeLabel()
Description copied from interface: CapabilityType
Human readable version of the key

Returns:

getViewTypeAction

@Nullable
public java.lang.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 java.lang.String getLabel(@NotNull
                                         java.lang.String key)
Description copied from interface: CapabilityType
The display label

Returns:

getExtraInfo

@Nullable
public java.lang.String getExtraInfo(@NotNull
                                              java.lang.String key)
Description copied from interface: CapabilityType
Displayed after the label

Returns:

getValueDescriptionKey

@Nullable
public java.lang.String getValueDescriptionKey(@NotNull
                                                        java.lang.String key,
                                                        @Nullable
                                                        java.lang.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 java.lang.String getNewKeyFromLabel(@NotNull
                                                   java.lang.String oldKey,
                                                   @NotNull
                                                   java.lang.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
                                  Build plan,
                                  @NotNull
                                  java.lang.String label)
Description copied from interface: CapabilityType
Perform custom work when the key has been updated. The label passed is the new label

Specified by:
updatePlanForNewLabel in interface CapabilityType
Overrides:
updatePlanForNewLabel in class AbstractCapabilityType

validate

@NotNull
public java.util.Map<java.lang.String,java.lang.String> validate(@NotNull
                                                                         java.util.Map<java.lang.String,java.lang.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
                                        java.util.Map<java.lang.String,java.lang.String[]> params)
Description copied from interface: CapabilityType
Returns a new capability given the action params map

Returns:
@TODO WMC 20080114 - Why did edwin make this @notnull? Need to check...

getBuilderTypes

public java.util.Collection<Builder> getBuilderTypes()

setBuilderManager

public void setBuilderManager(BuilderManager builderManager)

getBuilderManager

public BuilderManager getBuilderManager()


Copyright © 2009 Atlassian Pty Ltd. All Rights Reserved.