com.atlassian.jira.notification
Class NotificationFilterContext

java.lang.Object
  com.atlassian.jira.notification.NotificationFilterContext

Direct Known Subclasses:

IssueEventNotificationFilterContext

@PublicApi
public class NotificationFilterContext
extends Object

A context object is passed to each NotificationFilter instance. It tells you why the notification is being sent. It also allows state to be associated with it to help out each plugin.

Since:

6.0

Constructor Summary

NotificationFilterContext()

Method Summary

Object	get(String stateKey) Allows you to get previously put state into this context.
Issue	getIssue()
NotificationReason	getReason()
Object	put(String stateKey, Object stateValue) Allows you to put state into the Context.

Methods inherited from class java.lang.Object

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

Constructor Detail

NotificationFilterContext

public NotificationFilterContext()

Method Detail

getReason

public NotificationReason getReason()

getIssue

public Issue getIssue()

get

public Object get(String stateKey)

Allows you to get previously put state into this context.

Returns:

the value of the state object

put

public Object put(String stateKey,
                  Object stateValue)

Allows you to put state into the Context.

Parameters:

stateKey - the key of the staTe object

stateValue - the value of the state object

Returns:

the previs value eg Map.put(Object, Object)