ru.histone.v2.evaluator

Interface Function

All Known Implementing Classes:

AbstractFunction, ArrayChunk, ArrayEvery, ArrayFilter, ArrayFind, ArrayFirst, ArrayForEach, ArrayGroup, ArrayHas, ArrayHtmlEntities, ArrayIndexAware, ArrayJoin, ArrayLast, ArrayLength, ArrayMap, ArrayReduce, ArraySlice, ArraySome, ArraySort, ArrayToDate, AsyncLoadJson, AsyncLoadText, CallFunction, Case, Eval, GetBaseUri, GetDate, GetDayOfWeek, GetDaysInMonth, GetFunction, GetMethod, GetMinMax, GetMonthName, GetRand, GetUniqueId, GetWeekDayName, HasMethod, IsArray, IsBoolean, IsDate, IsFloat, IsInt, IsMacro, IsNull, IsNumber, IsRegExp, IsString, IsUndefined, Keys, LoadJson, LoadText, LocaleFunction, MacroBind, MacroCall, MacroExtend, Range, Require, ResolveURI, Reverse, StringCharCodeAt, StringHtmlEntities, StringLength, StringReplace, StringSlice, StringSplit, StringStrip, StringToDate, Test, ToAbs, ToArray, ToBoolean, ToCeil, ToChar, ToDate, ToFixed, ToFloor, ToJson, ToMacro, ToNumber, ToRound, ToString, Wait

public interface Function

Use this interface when you need to implement your own global function

Author:

Alexey Nevinsky

Method Summary

Modifier and Type	Method and Description
CompletableFuture<EvalNode>	execute(Context context, List<EvalNode> args) Method returns CompletableFuture with result of execution.
String	getName() Return function name
boolean	isAsync() Return true, if function must be run in own thread, otherwise - false
boolean	isClear()

Method Detail

getName

String getName()

Return function name

Returns:

function name

execute

CompletableFuture<EvalNode> execute(Context context,
                                    List<EvalNode> args)
                             throws FunctionExecutionException

Method returns CompletableFuture with result of execution.

Parameters:

context -

args - arguments from Histone template

Returns:

result as one of Histone types

Throws:

FunctionExecutionException - if your function stops with error and you need to put details into log, then you should use this exception

isAsync

boolean isAsync()

Return true, if function must be run in own thread, otherwise - false

Returns:

true if async function

isClear

boolean isClear()

Returns: