Class StringSubstringFunction
- java.lang.Object
-
- com.ezylang.evalex.functions.AbstractFunction
-
- com.ezylang.evalex.functions.string.StringSubstringFunction
-
- All Implemented Interfaces:
FunctionIfc
@FunctionParameter(name="string") @FunctionParameter(name="start",nonNegative=true) @FunctionParameter(name="end",isVarArg=true,nonNegative=true) public class StringSubstringFunction extends AbstractFunction
Returns a substring of a string.- Author:
- HSGamer
-
-
Field Summary
-
Fields inherited from class com.ezylang.evalex.functions.AbstractFunction
MINUS_ONE
-
-
Constructor Summary
Constructors Constructor Description StringSubstringFunction()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description EvaluationValueevaluate(Expression expression, Token functionToken, EvaluationValue... parameterValues)Performs the function logic and returns an evaluation result.voidvalidatePreEvaluation(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
-
-
-
-
Method Detail
-
validatePreEvaluation
public void validatePreEvaluation(Token token, EvaluationValue... parameterValues) throws EvaluationException
Description copied from interface:FunctionIfcValidates the evaluation parameters, called before the actual evaluation.- Specified by:
validatePreEvaluationin interfaceFunctionIfc- Overrides:
validatePreEvaluationin classAbstractFunction- Parameters:
token- The function token.parameterValues- The parameter values- Throws:
EvaluationException- in case of any validation error
-
evaluate
public EvaluationValue evaluate(Expression expression, Token functionToken, EvaluationValue... parameterValues) throws EvaluationException
Description copied from interface:FunctionIfcPerforms 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.
-
-