net.digitalid.utility.functional.interfaces

Interface Predicate<INPUT>

All Superinterfaces:

FailablePredicate<INPUT,RuntimeException>

@Immutable
 @Functional
public interface Predicate<INPUT>
extends FailablePredicate<INPUT,RuntimeException>

This functional interface models a predicate that evaluates whether an object of type INPUT satisfies a condition.

Field Summary

Fields

Modifier and Type	Field and Description
static @Nonnull Predicate<Object>	ALWAYS_FALSE Stores a predicate which always returns false.
static @Nonnull Predicate<Object>	ALWAYS_TRUE Stores a predicate which always returns true.

Method Summary

Modifier and Type	Method and Description
default <INITIAL_INPUT> @Nonnull Predicate<INITIAL_INPUT>	after(@Nonnull UnaryFunction<? super INITIAL_INPUT,? extends INPUT> function) Returns the composition of the given function followed by this predicate.
static <INPUT> @Nonnull Predicate<INPUT>	and(@Nonnull FiniteIterable<? extends Predicate<? super INPUT>> predicates) Returns the conjunction of the given predicates.
default @Nonnull Predicate<INPUT>	and(@Nonnull Predicate<? super INPUT> predicate) Returns the conjunction of this predicate with the given predicate.
default @Nonnull UnaryFunction<INPUT,Boolean>	asFunction() Returns this predicate as a unary function.
default @Nonnull Predicate<INPUT>	negate() Returns the negation of this predicate.
static <INPUT> @Nonnull Predicate<INPUT>	or(@Nonnull FiniteIterable<? extends Predicate<? super INPUT>> predicates) Returns the disjunction of the given predicates.
static <INPUT> @Nonnull Predicate<INPUT>	or(Predicate<? super INPUT>... predicates) Returns the disjunction of the given predicates.
default @Nonnull Predicate<INPUT>	or(@Nonnull Predicate<? super INPUT> predicate) Returns the disjunction of this predicate with the given predicate.
default @Nonnull Predicate<INPUT>	replaceNull(boolean defaultValue) Returns a new predicate based on this predicate that returns the given default value for null.

Methods inherited from interface net.digitalid.utility.functional.failable.FailablePredicate

after, and, compose, evaluate, or, or, suppressExceptions, suppressExceptions, suppressExceptions, suppressExceptions

Field Detail

ALWAYS_TRUE

@Nonnull
static final @Nonnull Predicate<Object> ALWAYS_TRUE

Stores a predicate which always returns true.

ALWAYS_FALSE

@Nonnull
static final @Nonnull Predicate<Object> ALWAYS_FALSE

Stores a predicate which always returns false.

Method Detail

and

@Pure
 @Nonnull
default @Nonnull Predicate<INPUT> and(@Nonnull
                                                      @Nonnull Predicate<? super INPUT> predicate)

Returns the conjunction of this predicate with the given predicate.

and

@Pure
 @Nonnull
static <INPUT> @Nonnull Predicate<INPUT> and(@Nonnull
                                                             @Nonnull FiniteIterable<? extends Predicate<? super INPUT>> predicates)

Returns the conjunction of the given predicates.

Specified by:

and in interface FailablePredicate<INPUT,RuntimeException>

or

@Pure
 @Nonnull
default @Nonnull Predicate<INPUT> or(@Nonnull
                                                     @Nonnull Predicate<? super INPUT> predicate)

Returns the disjunction of this predicate with the given predicate.

or

@Pure
 @SafeVarargs
 @Nonnull
static <INPUT> @Nonnull Predicate<INPUT> or(@Nonnull @NonNullableElements
                                                                          Predicate<? super INPUT>... predicates)

Returns the disjunction of the given predicates.

or

@Pure
 @Nonnull
static <INPUT> @Nonnull Predicate<INPUT> or(@Nonnull
                                                            @Nonnull FiniteIterable<? extends Predicate<? super INPUT>> predicates)

Returns the disjunction of the given predicates.

Specified by:

or in interface FailablePredicate<INPUT,RuntimeException>

negate

@Pure
 @Nonnull
default @Nonnull Predicate<INPUT> negate()

Description copied from interface: FailablePredicate

Returns the negation of this predicate.

Specified by:

negate in interface FailablePredicate<INPUT,RuntimeException>

after

@Pure
 @Nonnull
default <INITIAL_INPUT> @Nonnull Predicate<INITIAL_INPUT> after(@Nonnull
                                                                                @Nonnull UnaryFunction<? super INITIAL_INPUT,? extends INPUT> function)

Returns the composition of the given function followed by this predicate.

asFunction

@Pure
 @Nonnull
default @Nonnull UnaryFunction<INPUT,Boolean> asFunction()

Description copied from interface: FailablePredicate

Returns this predicate as a unary function.

Specified by:

asFunction in interface FailablePredicate<INPUT,RuntimeException>

replaceNull

@Pure
 @Nonnull
default @Nonnull Predicate<INPUT> replaceNull(boolean defaultValue)

Description copied from interface: FailablePredicate

Returns a new predicate based on this predicate that returns the given default value for null.

Specified by:

replaceNull in interface FailablePredicate<INPUT,RuntimeException>