Package org.apache.commons.functor.core.algorithm

Class GeneratorContains<T>

java.lang.Object

org.apache.commons.functor.core.algorithm.GeneratorContains<T>

Type Parameters:

T - the predicate argument type.

All Implemented Interfaces:

java.io.Serializable, BinaryFunctor<Generator<? extends T>,UnaryPredicate<? super T>>, BinaryPredicate<Generator<? extends T>,UnaryPredicate<? super T>>, Functor

public final class GeneratorContains<T>
extends java.lang.Object
implements BinaryPredicate<Generator<? extends T>,UnaryPredicate<? super T>>, java.io.Serializable

Tests whether a Generator contains an element that matches a UnaryPredicate.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	GeneratorContains.ContainsProcedure<T>	Helper procedure.

Field Summary

Fields

Modifier and Type	Field	Description
private static GeneratorContains<java.lang.Object>	INSTANCE	A static GeneratorContains instance reference.
private static long	serialVersionUID	serialVersionUID declaration.

Constructor Summary

Constructors

Constructor	Description
GeneratorContains()

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)	Indicates whether some other object is "equal to" this functor.
int	hashCode()	Returns a hash code for this functor adhering to the general Object.hashCode contract.
static GeneratorContains<java.lang.Object>	instance()	Get a static GeneratorContains instance.
boolean	test(Generator<? extends T> left, UnaryPredicate<? super T> right)	Evaluate this predicate.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.commons.functor.Functor

toString

Field Detail

serialVersionUID

private static final long serialVersionUID

serialVersionUID declaration.

See Also:

Constant Field Values

INSTANCE

private static final GeneratorContains<java.lang.Object> INSTANCE

A static GeneratorContains instance reference.

Constructor Detail

GeneratorContains

public GeneratorContains()

Method Detail

test

public boolean test(Generator<? extends T> left,
                    UnaryPredicate<? super T> right)

Evaluate this predicate.

Specified by:

test in interface BinaryPredicate<Generator<? extends T>,UnaryPredicate<? super T>>

Parameters:

left - Generator

right - UnaryPredicate

Returns:

the result of this test for the given arguments

equals

public boolean equals(java.lang.Object obj)

Indicates whether some other object is "equal to" this functor. This method must adhere to general Object.equals contract. Additionally, this method can return true only if the specified Object implements the same functor interface and is known to produce the same results and/or side-effects for the same arguments (if any).

While implementators are strongly encouraged to override the default Object implementation of this method, note that the default Object implementation does in fact adhere to the functor equals contract.

Specified by:

equals in interface Functor

Overrides:

equals in class java.lang.Object

Parameters:

obj - the object to compare this functor to

Returns:

true iff the given object implements this functor interface, and is known to produce the same results and/or side-effects for the same arguments (if any).

See Also:

Functor.hashCode()

hashCode

public int hashCode()

Returns a hash code for this functor adhering to the general Object.hashCode contract. Implementators are strongly encouraged but not strictly required to override the default Object implementation of this method.

Specified by:

hashCode in interface Functor

Overrides:

hashCode in class java.lang.Object

Returns:

a hash code for this functor

See Also:

Functor.equals(java.lang.Object)

instance

public static GeneratorContains<java.lang.Object> instance()

Get a static GeneratorContains instance.

Returns:

GeneratorContains