org.apache.commons.collections.functors
Class NotPredicate<T>

java.lang.Object
  org.apache.commons.collections.functors.NotPredicate<T>

All Implemented Interfaces:

Serializable, PredicateDecorator<T>, Predicate<T>

public final class NotPredicate<T>
extends Object
implements Predicate<T>, PredicateDecorator<T>, Serializable

Predicate implementation that returns the opposite of the decorated predicate.

Since:

Commons Collections 3.0

Version:

$Revision: 1.1.1.1 $ $Date: 2005/05/23 04:34:29 $

Author:

Matt Hall, John Watkinson, Stephen Colebourne

See Also:

Serialized Form

Constructor Summary

NotPredicate(Predicate<T> predicate)
Constructor that performs no validation.

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

NotPredicate

public NotPredicate(Predicate<T> predicate)

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

Parameters:

predicate - the predicate to call after the null check

Method Detail

getInstance

public static <T> Predicate<T> getInstance(Predicate<T> predicate)

Factory to create the not predicate.

Parameters:

predicate - the predicate to decorate, not null

Returns:

the predicate

Throws:

IllegalArgumentException - 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:

Commons Collections 3.1