Top Description Fields Methods
org.apache.commons.lang3.function

public Interface FailableBiPredicate<T, U, E extends Throwable>

Annotations
@FunctionalInterface
Type Parameters
<T>
Predicate type 1.
<U>
Predicate type 2.
<E>
The kind of thrown exception or error.
Imports
java.util.Objects, java.util.function.BiPredicate

A functional interface like BiPredicate that declares a Throwable.
Since
3.11

Field Summary

Modifier and TypeField and Description
public static final FailableBiPredicate<T, U, E extends Throwable>
FALSE

FALSE singleton

public static final FailableBiPredicate<T, U, E extends Throwable>
TRUE

TRUE singleton

Method Summary

Modifier and TypeMethod and Description
public default FailableBiPredicate<T, U, E>
and(final FailableBiPredicate<? super T, ? super U, E>
a predicate that will be logically-ANDed with this predicate.
other
)

Returns a composed FailableBiPredicate like BiPredicate#and(BiPredicate).

public static <
Consumed type 1.
T
,
Consumed type 2.
U
,
The kind of thrown exception or error.
E extends Throwable
>
FailableBiPredicate<T, U, E>

Returns:

The NOP singleton.
falsePredicate
()

Gets the FALSE singleton.

public default FailableBiPredicate<T, U, E>

Returns:

a predicate that negates this predicate.
negate
()

Returns a predicate that negates this predicate.

public default FailableBiPredicate<T, U, E>
or(final FailableBiPredicate<? super T, ? super U, E>
a predicate that will be logically-ORed with this predicate.
other
)

Returns a composed FailableBiPredicate like BiPredicate#and(BiPredicate).

public boolean

Returns:

the predicate's evaluation
test
(T
the first object to test the predicate on
object1
,
U
the second object to test the predicate on
object2
)

Tests the predicate.

public static <
Consumed type 1.
T
,
Consumed type 2.
U
,
The kind of thrown exception or error.
E extends Throwable
>
FailableBiPredicate<T, U, E>

Returns:

The NOP singleton.
truePredicate
()

Gets the TRUE singleton.

Field Detail

FALSEback to summary
public static final FailableBiPredicate<T, U, E extends Throwable> FALSE

FALSE singleton

Annotations
@SuppressWarnings:rawtypes
TRUEback to summary
public static final FailableBiPredicate<T, U, E extends Throwable> TRUE

TRUE singleton

Annotations
@SuppressWarnings:rawtypes

Method Detail

andback to summary
public default FailableBiPredicate<T, U, E> and(final FailableBiPredicate<? super T, ? super U, E> other)

Returns a composed FailableBiPredicate like BiPredicate#and(BiPredicate).

Parameters
other:FailableBiPredicate<? super T, ? super U, E>

a predicate that will be logically-ANDed with this predicate.

Returns:FailableBiPredicate<T, U, E>

a composed FailableBiPredicate like BiPredicate#and(BiPredicate).

Exceptions
NullPointerException:
if other is null
falsePredicateback to summary
public static <T, U, E extends Throwable> FailableBiPredicate<T, U, E> falsePredicate()

Gets the FALSE singleton.

Parameters
<T>
Consumed type 1.
<U>
Consumed type 2.
<E>
The kind of thrown exception or error.
Returns:FailableBiPredicate<T, U, E>

The NOP singleton.

Annotations
@SuppressWarnings:unchecked
negateback to summary
public default FailableBiPredicate<T, U, E> negate()

Returns a predicate that negates this predicate.

Returns:FailableBiPredicate<T, U, E>

a predicate that negates this predicate.

orback to summary
public default FailableBiPredicate<T, U, E> or(final FailableBiPredicate<? super T, ? super U, E> other)

Returns a composed FailableBiPredicate like BiPredicate#and(BiPredicate).

Parameters
other:FailableBiPredicate<? super T, ? super U, E>

a predicate that will be logically-ORed with this predicate.

Returns:FailableBiPredicate<T, U, E>

a composed FailableBiPredicate like BiPredicate#and(BiPredicate).

Exceptions
NullPointerException:
if other is null
testback to summary
public boolean test(T object1, U object2) throws E

Tests the predicate.

Parameters
object1:T

the first object to test the predicate on

object2:U

the second object to test the predicate on

Returns:boolean

the predicate's evaluation

Exceptions
E:
Thrown when this predicate fails.
truePredicateback to summary
public static <T, U, E extends Throwable> FailableBiPredicate<T, U, E> truePredicate()

Gets the TRUE singleton.

Parameters
<T>
Consumed type 1.
<U>
Consumed type 2.
<E>
The kind of thrown exception or error.
Returns:FailableBiPredicate<T, U, E>

The NOP singleton.

Annotations
@SuppressWarnings:unchecked