org.apache.commons.collections.functors
Class NotPredicate

java.lang.Object
  |
  +--org.apache.commons.collections.functors.NotPredicate
All Implemented Interfaces:
Predicate, Serializable

public final class NotPredicate
extends Object
implements Predicate, Serializable

Predicate implementation that returns the opposite of the decorated predicate.

Since:
Commons Collections 3.0
Version:
$Revision: 1.2 $ $Date: 2004/01/14 21:43:09 $
Author:
Stephen Colebourne
See Also:
Serialized Form

Constructor Summary
NotPredicate(Predicate predicate)
          Constructor that performs no validation.
 
Method Summary
 boolean evaluate(Object object)
          Return the negated predicate result.
static Predicate getInstance(Predicate predicate)
          Factory to create the not predicate.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

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

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

evaluate

public boolean evaluate(Object object)
Return the negated predicate result.
Specified by:
evaluate in interface Predicate
Following copied from interface: org.apache.commons.collections.Predicate
Parameters:
object - the object to evaluate
Returns:
true or false
Throws:
ClassCastException - (runtime) if the input is the wrong class
IllegalArgumentException - (runtime) if the input is invalid
FunctorException - (runtime) if the predicate encounters a problem


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