org.apache.commons.collections.functors

Class NotPredicate

public final class NotPredicate extends Object implements Predicate, PredicateDecorator, Serializable

Predicate implementation that returns the opposite of the decorated predicate.

Since: Commons Collections 3.0

Version: $Revision: 348444 $ $Date: 2005-11-23 14:06:56 +0000 (Wed, 23 Nov 2005) $

Author: Stephen Colebourne

Constructor Summary
NotPredicate(Predicate predicate)
Constructor that performs no validation.
Method Summary
booleanevaluate(Object object)
Evaluates the predicate returning the opposite to the stored predicate.
static PredicategetInstance(Predicate predicate)
Factory to create the not predicate.
Predicate[]getPredicates()
Gets the predicate being decorated.

Constructor Detail

NotPredicate

public NotPredicate(Predicate predicate)
Constructor that performs no validation. Use getInstance if you want that.

Parameters: predicate the predicate to call after the null check

Method Detail

evaluate

public boolean evaluate(Object object)
Evaluates the predicate returning the opposite to the stored predicate.

Parameters: object the input object

Returns: true if predicate returns false

getInstance

public static Predicate getInstance(Predicate 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

getPredicates

public Predicate[] getPredicates()
Gets the predicate being decorated.

Returns: the predicate as the only element in an array

Since: Commons Collections 3.1

Copyright © 2001-2008 Apache Software Foundation. All Rights Reserved.