com.atlassian.jira.plugin.jql.function

Class AbstractDateFunction

java.lang.Object

com.atlassian.jira.plugin.jql.function.AbstractJqlFunction

com.atlassian.jira.plugin.jql.function.AbstractDateFunction

All Implemented Interfaces:

JqlFunction

Direct Known Subclasses:

EndOfDayFunction, EndOfMonthFunction, EndOfWeekFunction, EndOfYearFunction, NowFunction, StartOfDayFunction, StartOfMonthFunction, StartOfWeekFunction, StartOfYearFunction

public abstract class AbstractDateFunction
extends AbstractJqlFunction

Function that produces the end of the month as the value.

Since:

v4.3

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractDateFunction.UNIT

Field Summary

Fields

Modifier and Type	Field and Description
protected com.atlassian.core.util.Clock	clock
protected TimeZoneManager	timeZoneManager

Method Summary

Modifier and Type	Method and Description
JiraDataType	getDataType() Provides the JiraDataType that this function handles and creates values for.
protected int	getDurationAmount(String duration)
protected int	getDurationUnit(String duration)
int	getMinimumNumberOfExpectedArguments() This method must return the number of arguments that the function expects to perform its operation correctly.
MessageSet	validate(ApplicationUser searcher, FunctionOperand operand, TerminalClause terminalClause) Will validate the function operand's arguments and report back any errors.

Methods inherited from class com.atlassian.jira.plugin.jql.function.AbstractJqlFunction

getFunctionName, getI18n, getModuleDescriptor, init, isList, validateNumberOfArgs

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.jira.plugin.jql.function.JqlFunction

getValues

Field Detail

clock

protected final com.atlassian.core.util.Clock clock

timeZoneManager

protected final TimeZoneManager timeZoneManager

Method Detail

validate

public MessageSet validate(ApplicationUser searcher,
                           FunctionOperand operand,
                           TerminalClause terminalClause)

Description copied from interface: JqlFunction

Will validate the function operand's arguments and report back any errors.

Parameters:

searcher - the user performing the search

operand - the operand to validate

terminalClause - the terminal clause that contains the operand

Returns:

a MessageSet which will contain any validation errors or warnings or will be empty if there is nothing to report; never null.

getDurationAmount

protected int getDurationAmount(String duration)

getDurationUnit

protected int getDurationUnit(String duration)

getMinimumNumberOfExpectedArguments

public int getMinimumNumberOfExpectedArguments()

Description copied from interface: JqlFunction

This method must return the number of arguments that the function expects to perform its operation correctly. If the function can accept a variable number of arguments this value should be the lower limit. It is perfectly legal for a function to take no arguments and return 0 for this method.

Returns:

the number of arguments that the function expects to perform its operation correctly. Must be >=0.

getDataType

public JiraDataType getDataType()

Description copied from interface: JqlFunction

Provides the JiraDataType that this function handles and creates values for. This allows us to infer some information about how it will interact with other elements in the system.

For example, if this returns JiraDataTypes.DATE then we know that we can provide values for any clauses that also specify a data type of DATE.

Returns:

the JiraDataType that this function produces values for. Cannot be null.

See Also:

JiraDataTypes