@PublicSpi public abstract class AbstractJqlFunction extends Object implements JqlFunction
JqlFunction
interface, that
provides sensible default behaviour for the init(JqlFunctionModuleDescriptor)
, getFunctionName()
and isList()
methods. You should not need to override these methods in your implementation.JqlFunction
Constructor and Description |
---|
AbstractJqlFunction() |
Modifier and Type | Method and Description |
---|---|
String |
getFunctionName()
The name of the function.
|
protected I18nHelper |
getI18n() |
JqlFunctionModuleDescriptor |
getModuleDescriptor() |
void |
init(JqlFunctionModuleDescriptor moduleDescriptor)
Initialises this pluggable function with it's module descriptor.
|
boolean |
isList()
This method should return true if the function is meant to be used with the IN or NOT IN operators, that is, if
the function should be viewed as returning a list.
|
protected MessageSet |
validateNumberOfArgs(FunctionOperand operand,
int expected) |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getDataType, getMinimumNumberOfExpectedArguments, getValues, validate
public void init(JqlFunctionModuleDescriptor moduleDescriptor)
JqlFunction
init
in interface JqlFunction
moduleDescriptor
- the module descriptor; will not be null.public JqlFunctionModuleDescriptor getModuleDescriptor()
protected MessageSet validateNumberOfArgs(FunctionOperand operand, int expected)
public String getFunctionName()
JqlFunction
getFunctionName
in interface JqlFunction
public boolean isList()
JqlFunction
As a general rule, if a function is going to return more than one value then it should return true here, otherwise it should return false. This does not necessarily need to be the case. For example, it is possible for function that returns false here to return more than one value when it is run.
isList
in interface JqlFunction
protected I18nHelper getI18n()
Copyright © 2002-2021 Atlassian. All Rights Reserved.