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

java.lang.Object
  org.apache.commons.collections4.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:

3.0

Version:

$Id: EqualPredicate.java 1477798 2013-04-30 19:49:02Z tn $

See Also:

Serialized Form

EqualPredicate

public EqualPredicate(T object)

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

Parameters:

object - the object to compare to

EqualPredicate

public EqualPredicate(T object,
                      Equator<T> equator)

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

Parameters:

object - the object to compare to

equator - the equator to use for comparison

Since:

4.0

equalPredicate

public static <T> Predicate<T> equalPredicate(T object)

Factory to create the predicate.

Type Parameters:

T - the type that the predicate queries

Parameters:

object - the object to compare to

Returns:

the predicate

Throws:

IllegalArgumentException - if the predicate is null

equalPredicate

public static <T> Predicate<T> equalPredicate(T object,
                                              Equator<T> equator)

Factory to create the identity predicate.

Type Parameters:

T - the type that the predicate queries

Parameters:

object - the object to compare to

equator - the equator to use for comparison

Returns:

the predicate

Throws:

IllegalArgumentException - if the predicate is null

Since:

4.0

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 Object getValue()

Gets the value.

Returns:

the value

Since:

3.1