Package Torello.Java.Function

Interface BoolPredicate

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface BoolPredicate

Function-Pointer Input: boolean Output: boolean.

This is similar to Java's IntPredicate, except it explicity requires a boolean type in it's lambda 'test' method.

Hi-Lited Source-Code:

• View Here: Torello/Java/Function/BoolPredicate.java
• Open New Browser-Tab: Torello/Java/Function/BoolPredicate.java

File Size: 2,078 Bytes Line Count: 57 '\n' Characters Found

Method Summary

@FunctionalInterface: (Lambda) Method
Modifier and Type	Method
boolean	test(boolean b)
Default Composition & Builder Method(s)
Modifier and Type	Method
default BoolPredicate	and(BoolPredicate other)
default BoolPredicate	negate()
default BoolPredicate	or(BoolPredicate other)

Method Detail

test

🡇 ⇈ ⮫ 🗕 🗗 🗖

boolean test(boolean b)

Evaluates this predicate on the given argument.

FunctionalInterface Target-Method:
This method corresponds to the @FunctionalInterface Annotation's method requirement. It is the only non-default, non-static method in this interface, and may be the target of a Lambda-Expression or '::' (double-colon) Function-Pointer.

Parameters:

b - primitive-boolean input argument.

Returns:

TRUE if the input argument matches this predicate, and FALSE otherwise.

and

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

default BoolPredicate and(BoolPredicate other)

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 - A predicate that will be logically-AND'ed with this predicate

Returns:

A composed predicate that represents the short-circuiting logical 'AND' of this predicate and the other predicate

Throws:

java.lang.NullPointerException - if parameter 'other' is null.

Code:

Exact Method Body:

 if (other == null)
     throw new NullPointerException("null has been passed to parameter 'other'");

 return (boolean b) -> this.test(b) && other.test(b);

negate

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

default BoolPredicate negate()

Returns a predicate that represents the logical negation of this predicate.

Returns:

A predicate that represents the logical negation of this predicate

Code:

Exact Method Body:

 return (boolean b) -> ! this.test(b);

or

🡅 ⇈ ⮫ 🗕 🗗 🗖

default BoolPredicate or(BoolPredicate other)

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 - a predicate that will be logically-ORed with this predicate

Returns:

a composed predicate that represents the short-circuiting logical 'OR' of this predicate and the other predicate

Throws:

java.lang.NullPointerException - if parameter 'other' is null.

Code:

Exact Method Body:

 if (other == null)
     throw new NullPointerException("null has been passed to parameter 'other'");

 return (boolean b) -> this.test(b) || other.test(b);