org.apache.commons.collections.functors
Class EqualPredicate<T>

java.lang.Object
  org.apache.commons.collections.functors.EqualPredicate<T>

All Implemented Interfaces:

Serializable, Predicate<T>

public final class EqualPredicate<T>
extends Object
implements Predicate<T>, 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: 1.1.1.1 $ $Date: 2005/05/23 04:34:17 $

Author:

Matt Hall, John Watkinson, Stephen Colebourne

See Also:

Serialized Form

Constructor Summary

EqualPredicate(T object)
Constructor that performs no validation.

Method Summary

boolean	evaluate(T object) Evaluates the predicate returning true if the input equals the stored value.
static <T> Predicate<T>	getInstance(T object) Factory to create the identity predicate.
T	getValue() Gets the value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EqualPredicate

public EqualPredicate(T object)

Constructor that performs no validation. Use getInstance if you want that.

Parameters:

object - the object to compare to

Method Detail

getInstance

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

Evaluates the predicate returning true if the input equals the stored value.

Specified by:

evaluate in interface Predicate<T>

Parameters:

object - the input object

Returns:

true if input object equals stored value

getValue

public T getValue()

Gets the value.

Returns:

the value

Since:

Commons Collections 3.1