BiPredicate
@FunctionalInterface interface BiPredicate<T : Any!, U : Any!>
| java.util.function.BiPredicate |
Represents a predicate (boolean-valued function) of two arguments. This is the two-arity specialization of Predicate.
This is a functional interface whose functional method is test(java.lang.Object,java.lang.Object).
Summary
| Public methods | |
|---|---|
| open BiPredicate<T, U>! |
and(other: BiPredicate<in T, in U>!)Returns a composed predicate that represents a short-circuiting logical AND of this predicate and another. |
| open BiPredicate<T, U>! |
negate()Returns a predicate that represents the logical negation of this predicate. |
| open BiPredicate<T, U>! |
or(other: BiPredicate<in T, in U>!)Returns a composed predicate that represents a short-circuiting logical OR of this predicate and another. |
| abstract Boolean |
test(t: T, u: U)Evaluates this predicate on the given arguments. |
Public methods
and
open fun and(other: BiPredicate<in T, in U>!): BiPredicate<T, U>!
Returns a composed predicate that represents a short-circuiting logical AND of this predicate and another. When evaluating the composed predicate, if this predicate is false, then the other predicate is not evaluated.
Any exceptions thrown during evaluation of either predicate are relayed to the caller; if evaluation of this predicate throws an exception, the other predicate will not be evaluated.
| Parameters | |
|---|---|
other |
BiPredicate<in T, in U>!: a predicate that will be logically-ANDed with this predicate |
| Return | |
|---|---|
BiPredicate<T, U>! |
a composed predicate that represents the short-circuiting logical AND of this predicate and the other predicate |
| Exceptions | |
|---|---|
java.lang.NullPointerException |
if other is null |
negate
open fun negate(): BiPredicate<T, U>!
Returns a predicate that represents the logical negation of this predicate.
| Return | |
|---|---|
BiPredicate<T, U>! |
a predicate that represents the logical negation of this predicate |
or
open fun or(other: BiPredicate<in T, in U>!): BiPredicate<T, U>!
Returns a composed predicate that represents a short-circuiting logical OR of this predicate and another. When evaluating the composed predicate, if this predicate is true, then the other predicate is not evaluated.
Any exceptions thrown during evaluation of either predicate are relayed to the caller; if evaluation of this predicate throws an exception, the other predicate will not be evaluated.
| Parameters | |
|---|---|
other |
BiPredicate<in T, in U>!: a predicate that will be logically-ORed with this predicate |
| Return | |
|---|---|
BiPredicate<T, U>! |
a composed predicate that represents the short-circuiting logical OR of this predicate and the other predicate |
| Exceptions | |
|---|---|
java.lang.NullPointerException |
if other is null |
test
abstract fun test(
t: T,
u: U
): Boolean
Evaluates this predicate on the given arguments.
| Parameters | |
|---|---|
t |
T: the first input argument |
u |
U: the second input argument |
| Return | |
|---|---|
Boolean |
true if the input arguments match the predicate, otherwise false |