Package com.ezylang.evalex.functions.datetime

Class DateTimeFormatFunction

java.lang.Object

com.ezylang.evalex.functions.AbstractFunction

com.ezylang.evalex.functions.datetime.DateTimeFormatFunction

All Implemented Interfaces:

FunctionIfc

@FunctionParameter(name="value") @FunctionParameter(name="parameters",isVarArg=true)
public class DateTimeFormatFunction
extends AbstractFunction

Function to format a DATE_TIME vale. Required parameter is the DATE_TIME value to format. First optional parameter is the format to use, using a pattern used by DateTimeFormatter. If no format is given, the first format defined in the configured formats is used. Second optional parameter is the zone-id to use with formatting. Default is the configured zone-id.

Field Summary

Fields inherited from class com.ezylang.evalex.functions.AbstractFunction

MINUS_ONE

Constructor Summary

Constructors

Constructor	Description
DateTimeFormatFunction()

Method Summary

Modifier and Type	Method	Description
EvaluationValue	evaluate(Expression expression, Token functionToken, EvaluationValue... parameterValues)	Performs the function logic and returns an evaluation result.
void	validatePreEvaluation(Token token, EvaluationValue... parameterValues)	Validates the evaluation parameters, called before the actual evaluation.

Methods inherited from class com.ezylang.evalex.functions.AbstractFunction

getFunctionParameterDefinitions, hasVarArgs

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ezylang.evalex.functions.FunctionIfc

getCountOfNonVarArgParameters, isParameterLazy

Constructor Detail

DateTimeFormatFunction

public DateTimeFormatFunction()

Method Detail

evaluate

public EvaluationValue evaluate(Expression expression,
                                Token functionToken,
                                EvaluationValue... parameterValues)
                         throws EvaluationException

Description copied from interface: FunctionIfc

Performs the function logic and returns an evaluation result.

Parameters:

expression - The expression, where this function is executed. Can be used to access the expression configuration.

functionToken - The function token from the parsed expression.

parameterValues - The parameter values.

Returns:

The evaluation result in form of a EvaluationValue.

Throws:

EvaluationException - In case there were problems during evaluation.

validatePreEvaluation

public void validatePreEvaluation(Token token,
                                  EvaluationValue... parameterValues)
                           throws EvaluationException

Description copied from interface: FunctionIfc

Validates the evaluation parameters, called before the actual evaluation.

Specified by:

validatePreEvaluation in interface FunctionIfc

Overrides:

validatePreEvaluation in class AbstractFunction

Parameters:

token - The function token.

parameterValues - The parameter values

Throws:

EvaluationException - in case of any validation error