org.apache.commons.collections4.functors

Class NotPredicate<T>

java.lang.Object

org.apache.commons.collections4.functors.NotPredicate<T>

All Implemented Interfaces:

java.io.Serializable, PredicateDecorator<T>, Predicate<T>

public final class NotPredicate<T>
extends java.lang.Object
implements PredicateDecorator<T>, java.io.Serializable

Predicate implementation that returns the opposite of the decorated predicate.

Since:

3.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
NotPredicate(Predicate<? super T> predicate) Constructor that performs no validation.

Method Summary

Modifier and Type	Method and Description
boolean	evaluate(T object) Evaluates the predicate returning the opposite to the stored predicate.
Predicate<? super T>[]	getPredicates() Gets the predicate being decorated.
static <T> Predicate<T>	notPredicate(Predicate<? super T> predicate) Factory to create the not predicate.

Methods inherited from class java.lang.Object

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

Constructor Detail

NotPredicate

public NotPredicate(Predicate<? super T> predicate)

Constructor that performs no validation. Use notPredicate if you want that.

Parameters:

predicate - the predicate to call after the null check

Method Detail

notPredicate

public static <T> Predicate<T> notPredicate(Predicate<? super T> predicate)

Factory to create the not predicate.

Type Parameters:

T - the type that the predicate queries

Parameters:

predicate - the predicate to decorate, not null

Returns:

the predicate

Throws:

java.lang.NullPointerException - if the predicate is null

evaluate

public boolean evaluate(T object)

Evaluates the predicate returning the opposite to the stored predicate.

Specified by:

evaluate in interface Predicate<T>

Parameters:

object - the input object

Returns:

true if predicate returns false

getPredicates

public Predicate<? super T>[] getPredicates()

Gets the predicate being decorated.

Specified by:

getPredicates in interface PredicateDecorator<T>

Returns:

the predicate as the only element in an array

Since:

3.1