com.atlassian.jira.plugin.jql.function
Class StartOfMonthFunction

java.lang.Object
  extended by com.atlassian.jira.plugin.jql.function.AbstractJqlFunction
      extended by com.atlassian.jira.plugin.jql.function.AbstractDateFunction
          extended by com.atlassian.jira.plugin.jql.function.StartOfMonthFunction
All Implemented Interfaces:
JqlFunction

public class StartOfMonthFunction
extends AbstractDateFunction

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

Since:
v4.3

Nested Class Summary
 
Nested classes/interfaces inherited from class com.atlassian.jira.plugin.jql.function.AbstractDateFunction
AbstractDateFunction.UNIT
 
Field Summary
static String FUNCTION_START_OF_MONTH
           
 
Fields inherited from class com.atlassian.jira.plugin.jql.function.AbstractDateFunction
clock, timeZoneManager
 
Constructor Summary
StartOfMonthFunction(TimeZoneManager timeZoneManager)
           
 
Method Summary
 List<QueryLiteral> getValues(QueryCreationContext queryCreationContext, FunctionOperand operand, TerminalClause terminalClause)
          Gets the unexpanded values provided by the user on input.
 
Methods inherited from class com.atlassian.jira.plugin.jql.function.AbstractDateFunction
getDataType, getDurationAmount, getDurationUnit, getMinimumNumberOfExpectedArguments, validate
 
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
 

Field Detail

FUNCTION_START_OF_MONTH

public static final String FUNCTION_START_OF_MONTH
See Also:
Constant Field Values
Constructor Detail

StartOfMonthFunction

public StartOfMonthFunction(TimeZoneManager timeZoneManager)
Method Detail

getValues

public List<QueryLiteral> getValues(QueryCreationContext queryCreationContext,
                                    FunctionOperand operand,
                                    TerminalClause terminalClause)
Description copied from interface: JqlFunction

Gets the unexpanded values provided by the user on input. This is the output values that will later be transformed into index values.

For example, a function who returns all the released versions of a specified project should return QueryLiterals representing the ids of those versions. For correctness, always opt to return the most specific identifier for the object; if you can return either the id (which is stored in the index) or a string name (that would require resolving to get the index value), choose the id.

Parameters:
queryCreationContext - the context of query creation
operand - the operand to get values from
terminalClause - the terminal clause that contains the operand
Returns:
a List of objects that represent this Operands raw values. Cannot be null.


Copyright © 2002-2014 Atlassian. All Rights Reserved.