Package com.atlassian.bamboo.v2.build.trigger

Class ScheduledTriggerReason

java.lang.Object

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

com.atlassian.bamboo.v2.build.trigger.ScheduledTriggerReason

All Implemented Interfaces:

TriggerReason, Serializable

public class ScheduledTriggerReason
extends AbstractTriggerReason

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static org.apache.commons.lang3.time.FastDateFormat	DATE_FORMAT
static String	DATE_FORMAT_STRING
static String	KEY
static String	TRIGGER_SCHEDULED_DATE

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

PLUGIN_KEY, TRIGGER_REASON_KEY

Constructor Summary

Constructors

Constructor	Description
ScheduledTriggerReason()

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.
@Nullable PlanResultKey	getPlanResultKey()
Date	getScheduledDate()
@Nullable String	getUserScheduledBy()
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	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

Field Detail

KEY

public static final String KEY

See Also:

Constant Field Values

TRIGGER_SCHEDULED_DATE

public static final String TRIGGER_SCHEDULED_DATE

See Also:

Constant Field Values

DATE_FORMAT_STRING

public static final String DATE_FORMAT_STRING

See Also:

Constant Field Values

DATE_FORMAT

public static final org.apache.commons.lang3.time.FastDateFormat DATE_FORMAT

Constructor Detail

ScheduledTriggerReason

public ScheduledTriggerReason()

Method Detail

init

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

Description copied from interface: TriggerReason

Initializes the TriggerReason using data from the Map

init

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

Description copied from interface: TriggerReason

Initializes the TriggerReason using data from the ResultsSummary

updateCustomData

public void updateCustomData(@NotNull
                             @NotNull BambooCustomDataAware customDataAware)

Description copied from interface: TriggerReason

Updates the TriggerReason given a BambooCustomDataAware

getName

public String getName()

Description copied from interface: TriggerReason

Gives the trigger reason

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"

Returns:

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

getScheduledDate

public Date getScheduledDate()

getPlanResultKey

@Nullable
public @Nullable PlanResultKey getPlanResultKey()

getUserScheduledBy

@Nullable
public @Nullable String getUserScheduledBy()