@PublicApi public class

NotificationFilterContext

extends Object
java.lang.Object
   ↳ com.atlassian.jira.notification.NotificationFilterContext
Known Direct Subclasses

@PublicApi

This class is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

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.

Summary

Public Constructors
NotificationFilterContext()
Public Methods
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.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public NotificationFilterContext ()

Public Methods

public Object get (String stateKey)

Allows you to get previously put state into this context.

Returns
  • the value of the state object

public Issue getIssue ()

public NotificationReason getReason ()

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