Package io.burt.jmespath.function

Class TransformByFunction

java.lang.Object

io.burt.jmespath.function.BaseFunction

io.burt.jmespath.function.TransformByFunction

All Implemented Interfaces:

Function

Direct Known Subclasses:

CompareByFunction, SortByFunction

public abstract class TransformByFunction
extends BaseFunction

Helper base class for higher order comparison functions like sort_by, max_by and min_by.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TransformByFunction.Aggregator<V>

Constructor Summary

Constructors

Constructor	Description
TransformByFunction()

Method Summary

Modifier and Type	Method	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> TransformByFunction.Aggregator<T>	createAggregator(Adapter<T> runtime, int elementCount, T element, T elementValue)
protected abstract <T> T	createNullValue(Adapter<T> runtime)

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

TransformByFunction

public TransformByFunction()

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

createAggregator

protected abstract <T> TransformByFunction.Aggregator<T> createAggregator(Adapter<T> runtime,
                                                                          int elementCount,
                                                                          T element,
                                                                          T elementValue)

createNullValue

protected abstract <T> T createNullValue(Adapter<T> runtime)