com.atlassian.bamboo.build.strategy
Class AbstractBuildStrategy

java.lang.Object
  com.atlassian.bamboo.build.strategy.AbstractBuildStrategy

All Implemented Interfaces:

BuildStrategy, BambooIdProvider, ConvertibleFromConfig, java.io.Serializable

Direct Known Subclasses:

AbstractQuartzStrategy, AfterSuccessfulPlanTrigger, ManualBuildStrategy, TriggeredBuildStrategy

public abstract class AbstractBuildStrategy
extends java.lang.Object
implements BuildStrategy

Common build strategy behaviour

See Also:

Serialized Form

Constructor Summary

AbstractBuildStrategy()

Method Summary

void	addDefaultValues(BuildConfiguration buildConfiguration)
boolean	canTrigger(java.lang.Class<? extends Triggerable> triggerableType) Default implementation: trigger only works for Chains
protected BuildStrategyManager	getBuildStrategyManager()
java.lang.String	getDescription()
long	getId()
protected com.opensymphony.xwork.TextProvider	getTextProvider()
java.util.Map<java.lang.String,java.lang.String>	getTriggerConditionsConfiguration()
java.lang.String	getUserDescription() Name under which this instance of build strategy appears on Plan's list of triggers.
void	init(Triggerable build) Default to do nothing
void	populateFromConfig(org.apache.commons.configuration.HierarchicalConfiguration config) Update the current object with data in the HierarchicalConfiguration
void	setId(long id)
void	setUserDescription(java.lang.String userDescription)
org.apache.commons.configuration.HierarchicalConfiguration	toConfiguration() Generate a HierarchicalConfiguration from the current state of the object
ErrorCollection	validate(BuildConfiguration buildConfiguration) Takes in a BuildConfiguration and returns any errors possible

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.bamboo.build.strategy.BuildStrategy

getKey, getName

Constructor Detail

AbstractBuildStrategy

public AbstractBuildStrategy()

Method Detail

init

public void init(@NotNull
                 Triggerable build)

Default to do nothing

Specified by:

init in interface BuildStrategy

addDefaultValues

public void addDefaultValues(BuildConfiguration buildConfiguration)

Specified by:

addDefaultValues in interface BuildStrategy

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface BuildStrategy

toConfiguration

@NotNull
public org.apache.commons.configuration.HierarchicalConfiguration toConfiguration()

Description copied from interface: ConvertibleFromConfig

Generate a HierarchicalConfiguration from the current state of the object

Specified by:

toConfiguration in interface ConvertibleFromConfig

Returns:

Always returns an HierarchicalConfiguration. Never null

populateFromConfig

public void populateFromConfig(@NotNull
                               org.apache.commons.configuration.HierarchicalConfiguration config)

Description copied from interface: ConvertibleFromConfig

Update the current object with data in the HierarchicalConfiguration

Specified by:

populateFromConfig in interface ConvertibleFromConfig

validate

public ErrorCollection validate(BuildConfiguration buildConfiguration)

Description copied from interface: BuildStrategy

Takes in a BuildConfiguration and returns any errors possible

Specified by:

validate in interface BuildStrategy

Parameters:

buildConfiguration - not null

Returns:

ErrorCollection. must not be null

getBuildStrategyManager

protected BuildStrategyManager getBuildStrategyManager()

getTextProvider

protected com.opensymphony.xwork.TextProvider getTextProvider()

getUserDescription

@NotNull
public java.lang.String getUserDescription()

Description copied from interface: BuildStrategy

Name under which this instance of build strategy appears on Plan's list of triggers.

Specified by:

getUserDescription in interface BuildStrategy

setUserDescription

public void setUserDescription(@NotNull
                               java.lang.String userDescription)

Specified by:

setUserDescription in interface BuildStrategy

getId

public long getId()

Specified by:

getId in interface BambooIdProvider

setId

public void setId(long id)

Specified by:

setId in interface BuildStrategy

getTriggerConditionsConfiguration

public java.util.Map<java.lang.String,java.lang.String> getTriggerConditionsConfiguration()

Specified by:

getTriggerConditionsConfiguration in interface BuildStrategy

Returns:

configuration of Trigger Conditions associated with this trigger.

canTrigger

public boolean canTrigger(@NotNull
                          java.lang.Class<? extends Triggerable> triggerableType)

Default implementation: trigger only works for Chains

Specified by:

canTrigger in interface BuildStrategy

Returns:

true iff build strategy is applicable to a Triggerable type