1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72

package Torello.Java.Function;

/**
 * Function-Pointer
 * <SPAN CLASS=TJF>Input:</SPAN> {@code A, B, C, D, E}
 * <SPAN CLASS=TJF>Output:</SPAN> {@code boolean}.
 * 
 * <BR /><BR />
 * <EMBED CLASS='external-html' DATA-FILE-ID=BIG_PREDICATE>
 * <EMBED CLASS="globalDefs" DATA-Name='Quint Predicate' DATA-Number=five>
 * 
 * @param <A> The type of the first input-parameter.
 * @param <B> The type of the second input-parameter.
 * @param <C> The type of the third input-parameter.
 * @param <D> The type of the fourth input-parameter.
 * @param <E> The type of the last input-parameter.
 */
@FunctionalInterface
public interface QuintPredicate<A, B, C, D, E>
{
    /**
     * Evaluates {@code "this"} predicate on the given arguments.
     * <BR /><BR /><EMBED CLASS='external-html' DATA-FILE-ID=FUNC_INTER_METH>
     *
     * @param a the first input argument
     * @param b the second input argument
     * @param c the third input argument
     * @param d the fourth input argument
     * @param e the fifth input argument
     * @return {@code TRUE} if the input arguments match the predicate, otherwise <B>FALSE</B>
     */
    public boolean test(A a, B b, C c, D d, E e);

    /**
     * <EMBED CLASS='external-html' DATA-FILE-ID=PRED_AND_METHOD>
     * @param other A predicate that will be logically-AND'ed with this predicate
     * @return <EMBED CLASS='external-html' DATA-FILE-ID=PRED_AND_RETURN>
     * @throws NullPointerException if parameter {@code 'other'} is null.
     */
    default QuintPredicate<A, B, C, D, E> and
        (QuintPredicate<? super A, ? super B, ? super C, ? super D, ? super E> other)
    {
        if (other == null)
            throw new NullPointerException("null has been passed to parameter 'other");

        return (A a, B b, C c, D d, E e) -> 
            this.test(a, b, c, d, e) && other.test(a, b, c, d, e);
    }

    /**
     * <EMBED CLASS='external-html' DATA-FILE-ID=PRED_NEGATE_METHOD>
     * @return <EMBED CLASS='external-html' DATA-FILE-ID=PRED_NEGATE_RETURN>
     */
    default QuintPredicate<A, B, C, D, E> negate()
    { return (A a, B b, C c, D d, E e) -> ! this.test(a, b, c, d, e); }

    /**
     * <EMBED CLASS='external-html' DATA-FILE-ID=PRED_OR_METHOD>
     * @param other a predicate that will be logically-ORed with this predicate
     * @return <EMBED CLASS='external-html' DATA-FILE-ID=PRED_OR_RETURN>
     * @throws NullPointerException if parameter {@code 'other'} is null.
     */
    default QuintPredicate<A, B, C, D, E> or
        (QuintPredicate<? super A, ? super B, ? super C, ? super D, ? super E> other)
    {
        if (other == null)
            throw new NullPointerException("null has been passed to parameter 'other");

        return (A a, B b, C c, D d, E e) -> 
            this.test(a, b, c, d, e) || other.test(a, b, c, d, e);
    }
}