io.burt.jmespath.function

Class ArrayMathFunction

java.lang.Object

io.burt.jmespath.function.BaseFunction

io.burt.jmespath.function.ArrayMathFunction

All Implemented Interfaces:

Function

Direct Known Subclasses:

AvgFunction, CompareFunction, SumFunction

public abstract class ArrayMathFunction
extends BaseFunction

Helper base class for functions that take an array and return a single value, like calculating the max, min or sum.

Subclasses can operate on any type of elements, and must provide that type as argument when calling super.

Constructor Summary

Constructors

Constructor and Description
ArrayMathFunction(ArgumentConstraint innerConstraint)

Method Summary

Modifier and Type	Method and Description
protected <T> T	callFunction(Adapter<T> runtime, List<FunctionArgument<T>> arguments) Called from BaseFunction.call(io.burt.jmespath.Adapter<T>, java.util.List<io.burt.jmespath.function.FunctionArgument<T>>) after the argument constraints have been checked against the arguments.
protected abstract <T> T	performMathOperation(Adapter<T> runtime, List<T> values) Subclasses implement this method.

Methods inherited from class io.burt.jmespath.function.BaseFunction

argumentConstraints, call, name

Methods inherited from class java.lang.Object

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

Constructor Detail

ArrayMathFunction

public ArrayMathFunction(ArgumentConstraint innerConstraint)

Method Detail

callFunction

protected <T> T callFunction(Adapter<T> runtime,
                             List<FunctionArgument<T>> arguments)

Description copied from class: BaseFunction

Called from BaseFunction.call(io.burt.jmespath.Adapter<T>, java.util.List<io.burt.jmespath.function.FunctionArgument<T>>) after the argument constraints have been checked against the arguments.

May perform additional type checking and throw ArgumentTypeException. For example when using expressions there is currently no way to check the types produced by those expressions without running the function. Functions that accept expressions are responsible for checking the types of the values produced by those expressions.

Specified by:

callFunction in class BaseFunction

performMathOperation

protected abstract <T> T performMathOperation(Adapter<T> runtime,
                                              List<T> values)

Subclasses implement this method.