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
boolean	arityViolated(int n)
<T> Iterator<ArgumentError>	check(Adapter<T> runtime, Iterator<FunctionArgument<T>> arguments, boolean expectNoRemainingArguments) Check that the argument list complies with the constraints.
String	expectedType()
int	maxArity()
int	minArity()

Method Detail

check

<T> Iterator<ArgumentError> check(Adapter<T> runtime,
                                  Iterator<FunctionArgument<T>> arguments,
                                  boolean expectNoRemainingArguments)

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.

Any errors found will be returned as an iterator of ArgumentError. When this iterator is empty no errors were found. The iterator may or may not contain all errors that could be found, errors may make the checker return as soon as they are encountered and not attempt to check the remaining arguments.

When expectNoRemainingArguments is true and there remain elements in the iterator after all checks have been performed an error will be returned.

minArity

int minArity()

Returns:

the minimum number of arguments required.

maxArity

int maxArity()

Returns:

the maximum number of arguments accepted.

arityViolated

boolean arityViolated(int n)

Parameters:

n - the number of arguments to check against minArity & maxArity

Returns:

true if any of the arity constraint failed.

expectedType

String expectedType()

Returns:

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