io.burt.jmespath.function

Class CompareByFunction

java.lang.Object

io.burt.jmespath.function.BaseFunction

io.burt.jmespath.function.CompareByFunction

All Implemented Interfaces:

Function

Direct Known Subclasses:

MaxByFunction, MinByFunction

public abstract class CompareByFunction
extends BaseFunction

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

Constructor Summary

Constructors

Constructor and Description
CompareByFunction()

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 boolean	sortsBefore(int compareResult) Subclasses override this method to decide whether the greatest or least element sorts first.

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

call, checkArguments, name

Methods inherited from class java.lang.Object

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

Constructor Detail

CompareByFunction

public CompareByFunction()

Method Detail

sortsBefore

protected abstract boolean sortsBefore(int compareResult)

Subclasses override this method to decide whether the greatest or least element sorts first.

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