Package com.atlassian.bamboo.trigger.dependency

Class CompletedStageTriggerReason

java.lang.Object

com.atlassian.bamboo.v2.build.trigger.AbstractTriggerReason

com.atlassian.bamboo.trigger.dependency.CompletedStageTriggerReason

All Implemented Interfaces:

BuildResultTriggerReason, TriggerReason, Serializable

public class CompletedStageTriggerReason
extends AbstractTriggerReason
implements TriggerReason, BuildResultTriggerReason

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY
static final String	TRIGGER_BUILD_RESULT_KEY
static final String	TRIGGER_STAGE_NAME_KEY

Fields inherited from class com.atlassian.bamboo.v2.build.trigger.AbstractTriggerReason

PLUGIN_KEY, TRIGGER_REASON_KEY

Constructor Summary

Constructors

Constructor	Description
CompletedStageTriggerReason()

Method Summary

Modifier and Type	Method	Description
String	getName()	Gives the trigger reason
String	getNameForSentence()	Gives the trigger reason in a format that can be used in a sentence eg.
String	getTriggeringBuildResultKey()
String	getTriggeringStageName()
void	init(String key, @NotNull ResultsSummary resultsSummary)	Initializes the TriggerReason using data from the ResultsSummary
void	init(String key, Map<String,String> fields)	Initializes the TriggerReason using data from the Map
void	setTriggeringBuildResultKey(String triggeringBuildResultKey)
void	setTriggeringStageName(String triggeringStageName)
void	updateCustomData(@NotNull BambooCustomDataAware customDataAware)	Updates the TriggerReason given a BambooCustomDataAware

Methods inherited from class com.atlassian.bamboo.v2.build.trigger.AbstractTriggerReason

getChildTriggerReason, getKey, init, toString, updateIfValueNotNull

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.bamboo.v2.build.trigger.TriggerReason

getChildTriggerReason, getKey

Field Details

KEY

public static final String KEY

See Also:

• Constant Field Values

TRIGGER_BUILD_RESULT_KEY

public static final String TRIGGER_BUILD_RESULT_KEY

See Also:

• Constant Field Values

TRIGGER_STAGE_NAME_KEY

public static final String TRIGGER_STAGE_NAME_KEY

See Also:

• Constant Field Values

Constructor Details

CompletedStageTriggerReason

public CompletedStageTriggerReason()

Method Details

getName

public String getName()

Description copied from interface: TriggerReason

Gives the trigger reason

Specified by:

getName in interface TriggerReason

Returns:

{String} - the trigger reason

getNameForSentence

public String getNameForSentence()

Description copied from interface: TriggerReason

Gives the trigger reason in a format that can be used in a sentence eg. "was triggered at the scheduled time of 6:34 PM"

Specified by:

getNameForSentence in interface TriggerReason

Returns:

{String} - the trigger reason, must be HTML escaped.

init

public void init(String key,
 Map<String,String> fields)

Description copied from interface: TriggerReason

Initializes the TriggerReason using data from the Map

Specified by:

init in interface TriggerReason

init

public void init(String key,
 @NotNull
 @NotNull ResultsSummary resultsSummary)

Description copied from interface: TriggerReason

Initializes the TriggerReason using data from the ResultsSummary

Specified by:

init in interface TriggerReason

updateCustomData

public void updateCustomData(@NotNull
 @NotNull BambooCustomDataAware customDataAware)

Description copied from interface: TriggerReason

Updates the TriggerReason given a BambooCustomDataAware

Specified by:

updateCustomData in interface TriggerReason

getTriggeringBuildResultKey

public String getTriggeringBuildResultKey()

Specified by:

getTriggeringBuildResultKey in interface BuildResultTriggerReason

setTriggeringBuildResultKey

public void setTriggeringBuildResultKey(String triggeringBuildResultKey)

getTriggeringStageName

public String getTriggeringStageName()

setTriggeringStageName

public void setTriggeringStageName(String triggeringStageName)