com.atlassian.bamboo.notification
Class AbstractNotification

java.lang.Object
  com.atlassian.bamboo.notification.AbstractNotification

All Implemented Interfaces:

Notification

Direct Known Subclasses:

AbstractCompletedNotification, AfterXFailedNotification, BuildErrorNotification, BuildHungNotification, BuildMissingCapableAgentNotification, BuildQueueTimeoutNotification, CommentNotification, StageCompletedNotification

public abstract class AbstractNotification
extends java.lang.Object
implements Notification

Constructor Summary

AbstractNotification()

Method Summary

void	addRecipient(NotificationRecipient recipient) Add a singular recipient to this notification
void	excludeRecipient(NotificationRecipient recipient) Exclude a singular recipient from this notification.
com.atlassian.event.Event	getEvent() Retrieves the event object that triggered this notification
java.util.Set<NotificationRecipient>	getExcludedNotificationRecipients() Returns the excluded recipients of this Notification
java.util.Set<NotificationRecipient>	getNotificationRecipients() Returns the recipients of this Notification
void	setEvent(com.atlassian.event.Event event) Sets the event object that triggered this notification
void	setExcludedNotificationRecipients(java.util.Set<NotificationRecipient> recipients) Sets the excluded recipients for this Notification
void	setNotificationRecipients(java.util.Set<NotificationRecipient> recipients) Sets the recipients for this Notification

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.notification.Notification

getDescription, getEmailSubject, getHtmlEmailContent, getIMContent, getTextEmailContent

Constructor Detail

AbstractNotification

public AbstractNotification()

Method Detail

setEvent

public void setEvent(@Nullable
                     com.atlassian.event.Event event)

Description copied from interface: Notification

Sets the event object that triggered this notification

Specified by:

setEvent in interface Notification

Parameters:

event - Event object that triggered this notification

getEvent

@Nullable
public com.atlassian.event.Event getEvent()

Description copied from interface: Notification

Retrieves the event object that triggered this notification

Specified by:

getEvent in interface Notification

Returns:

Event object that triggered this notification

getNotificationRecipients

@NotNull
public java.util.Set<NotificationRecipient> getNotificationRecipients()

Description copied from interface: Notification

Returns the recipients of this Notification

Specified by:

getNotificationRecipients in interface Notification

Returns:

Set of notification recipients

getExcludedNotificationRecipients

@NotNull
public java.util.Set<NotificationRecipient> getExcludedNotificationRecipients()

Description copied from interface: Notification

Returns the excluded recipients of this Notification

Specified by:

getExcludedNotificationRecipients in interface Notification

Returns:

Set of excluded notification recipients

setNotificationRecipients

public void setNotificationRecipients(@NotNull
                                      java.util.Set<NotificationRecipient> recipients)

Description copied from interface: Notification

Sets the recipients for this Notification

Specified by:

setNotificationRecipients in interface Notification

Parameters:

recipients - Set of notification recipients

setExcludedNotificationRecipients

public void setExcludedNotificationRecipients(@NotNull
                                              java.util.Set<NotificationRecipient> recipients)

Description copied from interface: Notification

Sets the excluded recipients for this Notification

Specified by:

setExcludedNotificationRecipients in interface Notification

Parameters:

recipients - Set of excluded notification recipients

addRecipient

public void addRecipient(@NotNull
                         NotificationRecipient recipient)

Description copied from interface: Notification

Add a singular recipient to this notification

Specified by:

addRecipient in interface Notification

Parameters:

recipient - Recipient to be added to notification

excludeRecipient

public void excludeRecipient(@NotNull
                             NotificationRecipient recipient)

Description copied from interface: Notification

Exclude a singular recipient from this notification. Recipient exclusion takes precedence over inclusion.

Specified by:

excludeRecipient in interface Notification

Parameters:

recipient - Recipient to be excluded from notification