io.burt.jmespath.function

Interface Function

All Known Implementing Classes:

AbsFunction, ArrayMathFunction, AvgFunction, BaseFunction, CeilFunction, CompareByFunction, CompareFunction, ContainsFunction, EndsWithFunction, FloorFunction, JoinFunction, KeysFunction, LengthFunction, MapFunction, MathFunction, MaxByFunction, MaxFunction, MergeFunction, MinByFunction, MinFunction, NotNullFunction, ReverseFunction, SortByFunction, SortFunction, StartsWithFunction, SumFunction, ToArrayFunction, ToNumberFunction, ToStringFunction, TransformByFunction, TypeFunction, ValuesFunction

public interface Function

Represents the implementation of a function available in JMESPath expressions. Custom function implementations should extend BaseFunction to get argument type checking, etc.

Method Summary

Modifier and Type	Method and Description
ArgumentConstraint	argumentConstraints() Returns the constraints to use when checking the list of arguments before the function is called.
<T> T	call(Adapter<T> runtime, List<FunctionArgument<T>> arguments) Call this function with a list of arguments.
String	name() Returns the name of the function.

Method Detail

name

String name()

Returns the name of the function.

The name is either automatically generated from the class name, or explicitly specified in the constructor.

argumentConstraints

ArgumentConstraint argumentConstraints()

Returns the constraints to use when checking the list of arguments before the function is called.

call

<T> T call(Adapter<T> runtime,
           List<FunctionArgument<T>> arguments)

Call this function with a list of arguments.

The arguments can be either values or expressions, and their types will be checked before proceeding with the call.

Throws:

ArgumentTypeException - when the function is called with arguments of the wrong type

ArityException - when the function is called with the wrong number of arguments