com.atlassian.jira.jql.operand
Class DefaultJqlFunctionHandlerRegistry

java.lang.Object
  com.atlassian.jira.jql.operand.DefaultJqlFunctionHandlerRegistry

All Implemented Interfaces:

Startable, JqlFunctionHandlerRegistry

@InjectableComponent
public class DefaultJqlFunctionHandlerRegistry
extends Object
implements JqlFunctionHandlerRegistry, Startable

Since:

v4.0

Constructor Summary

DefaultJqlFunctionHandlerRegistry(com.atlassian.event.api.EventPublisher eventPublisher, com.atlassian.plugin.PluginAccessor pluginAccessor)

Method Summary

List<String>	getAllFunctionNames() Fetches all function names ordered alphabetically.
FunctionOperandHandler	getOperandHandler(FunctionOperand operand) Fetches the associated OperandHandler for the provided FunctionOperand.
void	onClearCache(ClearCacheEvent event)
void	registerFunctionHandler(JqlFunction jqlFunction) Registers a JqlFunction plugin once it has been enabled by the system.
void	start() This method wil be called after the plugin system is fully initialised and all components added to the dependency injection framework.
void	unregisterFunctionHandler(JqlFunction jqlFunction) Unregisters a JqlFunction plugin.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultJqlFunctionHandlerRegistry

public DefaultJqlFunctionHandlerRegistry(com.atlassian.event.api.EventPublisher eventPublisher,
                                         com.atlassian.plugin.PluginAccessor pluginAccessor)

Method Detail

start

public void start()
           throws Exception

Description copied from interface: Startable

This method wil 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.

onClearCache

@EventListener
public void onClearCache(ClearCacheEvent event)

registerFunctionHandler

public void registerFunctionHandler(JqlFunction jqlFunction)

Description copied from interface: JqlFunctionHandlerRegistry

Registers a JqlFunction plugin once it has been enabled by the system.

Specified by:

registerFunctionHandler in interface JqlFunctionHandlerRegistry

Parameters:

jqlFunction - the actual function to register.

unregisterFunctionHandler

public void unregisterFunctionHandler(JqlFunction jqlFunction)

Description copied from interface: JqlFunctionHandlerRegistry

Unregisters a JqlFunction plugin.

Specified by:

unregisterFunctionHandler in interface JqlFunctionHandlerRegistry

Parameters:

jqlFunction - the actual function to unregister.

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.