com.annimon.stream.function

Class Predicate.Util

java.lang.Object

com.annimon.stream.function.Predicate.Util

Enclosing interface:

Predicate<T>

public static class Predicate.Util
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
static <T> Predicate<T>	and(Predicate<? super T> p1, Predicate<? super T> p2) Applies logical AND to predicates.
static <T> Predicate<T>	and(Predicate<? super T> p1, Predicate<? super T> p2, Predicate<? super T>... rest) Applies logical AND to multiple predicates.
static <T> Predicate<T>	negate(Predicate<? super T> predicate) Applies logical negation to predicate.
static <T> Predicate<T>	notNull() Checks that input value is not null.
static <T> Predicate<T>	or(Predicate<? super T> p1, Predicate<? super T> p2) Applies logical OR to predicates.
static <T> Predicate<T>	or(Predicate<? super T> p1, Predicate<? super T> p2, Predicate<? super T>... rest) Applies logical OR to multiple predicates.
static <T> Predicate<T>	safe(ThrowablePredicate<? super T,java.lang.Throwable> throwablePredicate) Creates a safe Predicate.
static <T> Predicate<T>	safe(ThrowablePredicate<? super T,java.lang.Throwable> throwablePredicate, boolean resultIfFailed) Creates a safe Predicate.
static <T> Predicate<T>	xor(Predicate<? super T> p1, Predicate<? super T> p2) Applies logical XOR to predicates.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

and

public static <T> Predicate<T> and(@NotNull
                                   Predicate<? super T> p1,
                                   @NotNull
                                   Predicate<? super T> p2)

Applies logical AND to predicates.

Type Parameters:

T - the type of the input to the function

Parameters:

p1 - the first predicate

p2 - the second predicate

Returns:

a composed Predicate

Throws:

java.lang.NullPointerException - if p1 or p2 is null

and

public static <T> Predicate<T> and(@NotNull
                                   Predicate<? super T> p1,
                                   @NotNull
                                   Predicate<? super T> p2,
                                   @NotNull
                                   Predicate<? super T>... rest)

Applies logical AND to multiple predicates.

Type Parameters:

T - the type of the input to the function

Parameters:

p1 - the first predicate

p2 - the second predicate

rest - the rest predicates

Returns:

a composed Predicate

Throws:

java.lang.NullPointerException - if any of predicates are null

Since:

1.2.1

or

public static <T> Predicate<T> or(@NotNull
                                  Predicate<? super T> p1,
                                  @NotNull
                                  Predicate<? super T> p2)

Applies logical OR to predicates.

Type Parameters:

T - the type of the input to the function

Parameters:

p1 - the first predicate

p2 - the second predicate

Returns:

a composed Predicate

Throws:

java.lang.NullPointerException - if p1 or p2 is null

or

public static <T> Predicate<T> or(@NotNull
                                  Predicate<? super T> p1,
                                  @NotNull
                                  Predicate<? super T> p2,
                                  @NotNull
                                  Predicate<? super T>... rest)

Applies logical OR to multiple predicates.

Type Parameters:

T - the type of the input to the function

Parameters:

p1 - the first predicate

p2 - the second predicate

rest - the rest predicates

Returns:

a composed Predicate

Throws:

java.lang.NullPointerException - if any of predicates are null

xor

public static <T> Predicate<T> xor(@NotNull
                                   Predicate<? super T> p1,
                                   @NotNull
                                   Predicate<? super T> p2)

Applies logical XOR to predicates.

Type Parameters:

T - the type of the input to the function

Parameters:

p1 - the first predicate

p2 - the second predicate

Returns:

a composed Predicate

Throws:

java.lang.NullPointerException - if p1 or p2 is null

negate

public static <T> Predicate<T> negate(@NotNull
                                      Predicate<? super T> predicate)

Applies logical negation to predicate.

Type Parameters:

T - the type of the input to the function

Parameters:

predicate - the predicate to be negated

Returns:

a composed Predicate

Throws:

java.lang.NullPointerException - if p1 is null

notNull

public static <T> Predicate<T> notNull()

Checks that input value is not null.

Type Parameters:

T - the type of the input to the function

Returns:

Predicate that checks value to be not null

safe

public static <T> Predicate<T> safe(@NotNull
                                    ThrowablePredicate<? super T,java.lang.Throwable> throwablePredicate)

Creates a safe Predicate.

Type Parameters:

T - the type of the input to the function

Parameters:

throwablePredicate - the predicate that may throw an exception

Returns:

a Predicate or false if exception was thrown

safe

public static <T> Predicate<T> safe(@NotNull
                                    ThrowablePredicate<? super T,java.lang.Throwable> throwablePredicate,
                                    boolean resultIfFailed)

Creates a safe Predicate.

Type Parameters:

T - the type of the input to the function

Parameters:

throwablePredicate - the predicate that may throw an exception

resultIfFailed - the result which returned if exception was thrown

Returns:

a Predicate or resultIfFailed

Throws:

java.lang.NullPointerException - if throwablePredicate is null