org.apache.commons.collections.functors

Class NotPredicate

Implemented Interfaces:
Predicate, PredicateDecorator, Serializable

public final class NotPredicate
extends java.lang.Object
implements Predicate, PredicateDecorator, Serializable

Predicate implementation that returns the opposite of the decorated predicate.

Version:
$Revision: 1.6 $ $Date: 2004/05/31 16:43:17 $

Author:
Stephen Colebourne

Since:
Commons Collections 3.0

Constructor Summary

NotPredicate(Predicate predicate)
Constructor that performs no validation.

Method Summary

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

Constructor Details

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 Details

evaluate

public boolean evaluate(Object object)
Evaluates the predicate returning the opposite to the stored predicate.
Specified by:
evaluate in interface 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


getPredicates

public Predicate[] getPredicates()
Gets the predicate being decorated.
Specified by:
getPredicates in interface PredicateDecorator

Returns:
the predicate as the only element in an array

Since:
Commons Collections 3.1


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