com.github.robtimus.io.function

Interface IOPredicate<T>

Type Parameters:

T - The type of the input to the predicate.

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 IOPredicate<T>

Represents a predicate (boolean-valued function) of one argument. This is the IOException throwing equivalent of Predicate.

Method Summary

Modifier and Type	Method and Description
default IOPredicate<T>	and(IOPredicate<? super T> other) Returns a composed predicate that represents a short-circuiting logical AND of this predicate and another.
static <T> IOPredicate<T>	checked(Predicate<? super T> predicate) Returns a predicate that evaluates the predicate predicate, and unwraps any UncheckedIOException that is thrown by throwing its cause.
static <T> IOPredicate<T>	isEqual(Object targetRef) Returns a predicate that tests if two arguments are equal according to Objects.equals(Object, Object).
default IOPredicate<T>	negate() Returns a predicate that represents the logical negation of this predicate.
static <T> IOPredicate<T>	not(IOPredicate<? super T> target) Returns a predicate that represents the logical negation of another predicate.
default IOPredicate<T>	or(IOPredicate<? super T> other) Returns a composed predicate that represents a short-circuiting logical OR of this predicate and another.
boolean	test(T t) Evaluates this predicate on the given argument.
static <T> Predicate<T>	unchecked(IOPredicate<? super T> predicate) Returns a predicate that evaluates the predicate predicate, and wraps any IOException that is thrown in an UncheckedIOException.

Method Detail

test

boolean test(T t)
      throws IOException

Evaluates this predicate on the given argument.

Parameters:

t - The input argument.

Returns:

true if the input argument matches the predicate, otherwise false.

Throws:

IOException - If an I/O error occurs.

and

default IOPredicate<T> and(IOPredicate<? super T> 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-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.

negate

default IOPredicate<T> negate()

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

Returns:

A predicate that represents the logical negation of this predicate

or

default IOPredicate<T> or(IOPredicate<? super T> 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:

NullPointerException - If other is null.

isEqual

static <T> IOPredicate<T> isEqual(Object targetRef)

Returns a predicate that tests if two arguments are equal according to Objects.equals(Object, Object).

Type Parameters:

T - The type of arguments to the predicate.

Parameters:

targetRef - The object reference with which to compare for equality, which may be null.

Returns:

A predicate that tests if two arguments are equal according to Objects.equals(Object, Object).

unchecked

static <T> Predicate<T> unchecked(IOPredicate<? super T> predicate)

Returns a predicate that evaluates the predicate predicate, and wraps any IOException that is thrown in an UncheckedIOException.

Type Parameters:

T - The type of arguments to the predicate.

Parameters:

predicate - The predicate to evaluate when the returned predicate is evaluated.

Returns:

A predicate that evaluates the predicate predicate on its input, and wraps any IOException that is thrown in an UncheckedIOException.

Throws:

NullPointerException - If predicate is null.

checked

static <T> IOPredicate<T> checked(Predicate<? super T> predicate)

Returns a predicate that evaluates the predicate predicate, and unwraps any UncheckedIOException that is thrown by throwing its cause.

Type Parameters:

T - The type of arguments to the predicate.

Parameters:

predicate - The predicate to evaluate when the returned predicate is evaluated.

Returns:

A predicate that evaluates the predicate operation on its input, and unwraps any UncheckedIOException that is thrown.

Throws:

NullPointerException - If the given operation is null.

not

static <T> IOPredicate<T> not(IOPredicate<? super T> target)

Returns a predicate that represents the logical negation of another predicate. This is accomplished by returning the result of calling target.negate().

Type Parameters:

T - The type of the argument to the predicate.

Parameters:

target - The predicate to negate.

Returns:

A predicate that represents the logical negation of the given predicate

Throws:

NullPointerException - If the given predicate is null.

Since:

1.1