io.burt.jmespath.function

Interface ArgumentConstraint

public interface ArgumentConstraint

A description of the expected type of an argument or list of arguments passed to a function.

Method Summary

Modifier and Type	Method and Description
<T> void	check(Adapter<T> runtime, Iterator<FunctionArgument<T>> arguments) Check that the argument list complies with the constraints.
String	expectedType()
int	maxArity()
int	minArity()

Method Detail

check

<T> void check(Adapter<T> runtime,
               Iterator<FunctionArgument<T>> arguments)

Check that the argument list complies with the constraints.

Most constraints will consume one or more elements from the iterator, but constraints that represents optional arguments may choose not to.

Throws:

ArityException - when there are not enough arguments left to satisfy the constraint

ArgumentTypeException - when an argument does not satisfy the constraint

minArity

int minArity()

Returns:

the minimum number of arguments required.

maxArity

int maxArity()

Returns:

the maximum number of arguments accepted.

expectedType

String expectedType()

Returns:

a string representation of the types accepted. Used to construct user friendly error messages.