org.apache.commons.collections.functors

Class EqualPredicate

public final class EqualPredicate extends Object implements Predicate, Serializable

Predicate implementation that returns true if the input is the same object as the one stored in this predicate by equals.

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
EqualPredicate(Object object)
Constructor that performs no validation.
Method Summary
booleanevaluate(Object object)
Evaluates the predicate returning true if the input equals the stored value.
static PredicategetInstance(Object object)
Factory to create the identity predicate.
ObjectgetValue()
Gets the value.

Constructor Detail

EqualPredicate

public EqualPredicate(Object object)
Constructor that performs no validation. Use getInstance if you want that.

Parameters: object the object to compare to

Method Detail

evaluate

public boolean evaluate(Object object)
Evaluates the predicate returning true if the input equals the stored value.

Parameters: object the input object

Returns: true if input object equals stored value

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

getValue

public Object getValue()
Gets the value.

Returns: the value

Since: Commons Collections 3.1

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