Package com.helger.commons.functional

Interface ICharPredicate

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 ICharPredicate

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

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

Since:

9.0.0

See Also:

Predicate

Method Summary

Modifier and Type	Method	Description
default ICharPredicate	and(ICharPredicate aOther)	Returns a composed predicate that represents a short-circuiting logical AND of this predicate and another.
default ICharPredicate	negate()	Returns a predicate that represents the logical negation of this predicate.
default ICharPredicate	or(ICharPredicate aOther)	Returns a composed predicate that represents a short-circuiting logical OR of this predicate and another.
boolean	test(char cValue)	Evaluates this predicate on the given argument.

Method Detail

test

boolean test(char cValue)

Evaluates this predicate on the given argument.

Parameters:

cValue - the input argument

Returns:

true if the input argument matches the predicate, otherwise false

negate

@Nonnull
default ICharPredicate 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 ICharPredicate and(@Nonnull
                           ICharPredicate 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 ICharPredicate or(@Nonnull
                          ICharPredicate 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