org.apache.commons.collections.functors
Class IdentityPredicate

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

public final class IdentityPredicate
extends Object
implements Predicate, Serializable

Predicate implementation that returns true if the input is the same object as the one stored in this 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
IdentityPredicate(Object object)
          Constructor that performs no validation.
 
Method Summary
 boolean evaluate(Object object)
          Return the predicate result.
static Predicate getInstance(Object object)
          Factory to create the identity predicate.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IdentityPredicate

public IdentityPredicate(Object object)
Constructor that performs no validation. Use getInstance if you want that.
Parameters:
object - the object to compare to
Method Detail

getInstance

public static Predicate getInstance(Object object)
Factory to create the identity predicate.
Parameters:
object - the object to compare to
Returns:
the predicate
Throws:
IllegalArgumentException - if the predicate is null

evaluate

public boolean evaluate(Object object)
Return the 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.