com.atlassian.jira.jql.operand.registry

Class PluginsAwareJqlFunctionHandlerRegistry

java.lang.Object

com.atlassian.jira.jql.operand.registry.PluginsAwareJqlFunctionHandlerRegistry

All Implemented Interfaces:

Startable, JqlFunctionHandlerRegistry

public class PluginsAwareJqlFunctionHandlerRegistry
extends Object
implements JqlFunctionHandlerRegistry, Startable

Represents a JqlFunctionHandlerRegistry that can detect when the plugins system enables / disables new jql function modules and updates the registry of function operand handlers accordingly.

The current implementation is backed by a LazyResettableJqlFunctionHandlerRegistry.

Since:

v4.4

Constructor Summary

Constructors

Constructor and Description
PluginsAwareJqlFunctionHandlerRegistry(com.atlassian.plugin.PluginAccessor pluginAccessor, com.atlassian.event.api.EventPublisher eventPublisher, ModuleDescriptors.Orderings moduleDescriptorOrderings, I18nHelper i18nHelper)

Method Summary

Modifier and Type	Method and Description
List<String>	getAllFunctionNames() Fetches all function names ordered alphabetically.
FunctionOperandHandler	getOperandHandler(FunctionOperand operand) Fetches the associated OperandHandler for the provided FunctionOperand.
void	onJiraPluginCacheResetEvent(JiraPluginCacheResetEvent event)
void	start() This method will be called after the plugin system is fully initialised and all components added to the dependency injection framework.

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginsAwareJqlFunctionHandlerRegistry

public PluginsAwareJqlFunctionHandlerRegistry(com.atlassian.plugin.PluginAccessor pluginAccessor,
                                              com.atlassian.event.api.EventPublisher eventPublisher,
                                              ModuleDescriptors.Orderings moduleDescriptorOrderings,
                                              I18nHelper i18nHelper)

Method Detail

onJiraPluginCacheResetEvent

@EventListener
public void onJiraPluginCacheResetEvent(JiraPluginCacheResetEvent event)

getOperandHandler

public FunctionOperandHandler getOperandHandler(FunctionOperand operand)

Description copied from interface: JqlFunctionHandlerRegistry

Fetches the associated OperandHandler for the provided FunctionOperand. The returned handler is looked up by the name of the FunctionOperand (case insensitive).

Specified by:

getOperandHandler in interface JqlFunctionHandlerRegistry

Parameters:

operand - that defines the name for which we want to find the operand handler.

Returns:

the operand handler associated with this operand, null if there is none.

getAllFunctionNames

public List<String> getAllFunctionNames()

Description copied from interface: JqlFunctionHandlerRegistry

Fetches all function names ordered alphabetically.

Specified by:

getAllFunctionNames in interface JqlFunctionHandlerRegistry

Returns:

all function names ordered alphabetically, an empty collection if there are none.

start

public void start()
           throws Exception

Description copied from interface: Startable

This method will be called after the plugin system is fully initialised and all components added to the dependency injection framework.

Specified by:

start in interface Startable

Throws:

Exception - Allows implementations to throw an Exception.