Package com.helger.commons.functional

Interface IBooleanPredicate

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 IBooleanPredicate

Represents a predicate (boolean-valued function) of one boolean-valued argument. This is the boolean-consuming primitive type specialization of Predicate.

This is a functional interface whose functional method is test(boolean).

Since:

8.5.2

See Also:

Predicate

Method Summary

Modifier and Type	Method	Description
static IBooleanPredicate	all()
default IBooleanPredicate	and(IBooleanPredicate aOther)	Returns a composed predicate that represents a short-circuiting logical AND of this predicate and another.
static IBooleanPredicate	ifFalse()
static IBooleanPredicate	ifTrue()
default IBooleanPredicate	negate()	Returns a predicate that represents the logical negation of this predicate.
static IBooleanPredicate	none()
default IBooleanPredicate	or(IBooleanPredicate aOther)	Returns a composed predicate that represents a short-circuiting logical OR of this predicate and another.
boolean	test(boolean bValue)	Evaluates this predicate on the given argument.

Method Detail

test

boolean test(boolean bValue)

Evaluates this predicate on the given argument.

Parameters:

bValue - the input argument

Returns:

true if the input argument matches the predicate, otherwise false

negate

@Nonnull
default IBooleanPredicate negate()

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

Returns:

a predicate that represents the logical negation of this predicate

and

@Nonnull
default IBooleanPredicate and(@Nonnull
                              IBooleanPredicate aOther)

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:

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

Returns:

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

Throws:

NullPointerException - if other is null

or

@Nonnull
default IBooleanPredicate or(@Nonnull
                             IBooleanPredicate aOther)

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:

aOther - 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:

NullPointerException - if other is null

all

@Nonnull
static IBooleanPredicate all()

none

@Nonnull
static IBooleanPredicate none()

ifTrue

@Nonnull
static IBooleanPredicate ifTrue()

ifFalse

@Nonnull
static IBooleanPredicate ifFalse()