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

Class FindWithinGenerator<E>

java.lang.Object

org.apache.commons.functor.core.algorithm.FindWithinGenerator<E>

Type Parameters:

E - the arguments type.

All Implemented Interfaces:

java.io.Serializable, BinaryFunction<Generator<? extends E>,UnaryPredicate<? super E>,E>, BinaryFunctor<Generator<? extends E>,UnaryPredicate<? super E>>, Functor

public final class FindWithinGenerator<E>
extends java.lang.Object
implements BinaryFunction<Generator<? extends E>,UnaryPredicate<? super E>,E>, java.io.Serializable

Return the first Object in a Generator matching a UnaryPredicate.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	FindWithinGenerator.FindProcedure<T>	Helper procedure.

Field Summary

Fields

Modifier and Type	Field	Description
private E	ifNone	Object to be returned in the case the adapted procedure does not find any object.
static FindWithinGenerator<java.lang.Object>	INSTANCE	Basic instance.
private static long	serialVersionUID	serialVersionUID declaration.
private boolean	useIfNone	Flag to mark the evaluate(Generator, UnaryPredicate) method must return a user defined object when the adapted procedure does not find any object.

Constructor Summary

Constructors

Constructor	Description
FindWithinGenerator()	Create a new FindWithinGenerator.
FindWithinGenerator(E ifNone)	Create a new FindWithinGenerator.

Method Summary

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

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

INSTANCE

public static final FindWithinGenerator<java.lang.Object> INSTANCE

Basic instance.

serialVersionUID

private static final long serialVersionUID

serialVersionUID declaration.

See Also:

Constant Field Values

useIfNone

private final boolean useIfNone

Flag to mark the evaluate(Generator, UnaryPredicate) method must return a user defined object when the adapted procedure does not find any object.

ifNone

private final E ifNone

Object to be returned in the case the adapted procedure does not find any object.

Constructor Detail

FindWithinGenerator

public FindWithinGenerator()

Create a new FindWithinGenerator.

FindWithinGenerator

public FindWithinGenerator(E ifNone)

Create a new FindWithinGenerator.

Parameters:

ifNone - object to return if the Generator contains no matches.

Method Detail

evaluate

public E evaluate(Generator<? extends E> left,
                  UnaryPredicate<? super E> right)

Evaluate this function.

Specified by:

evaluate in interface BinaryFunction<Generator<? extends E>,UnaryPredicate<? super E>,E>

Parameters:

left - Generator

right - UnaryPredicate

Returns:

the T result of this function 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 FindWithinGenerator<java.lang.Object> instance()

Get a static FindWithinGenerator instance.

Returns:

FindWithinGenerator