org.apache.commons.functor.core.algorithm
Class RecursiveEvaluation

java.lang.Object
  extended by org.apache.commons.functor.core.algorithm.RecursiveEvaluation
All Implemented Interfaces:
Serializable, Function<Object>, Functor, NullaryFunctor

public class RecursiveEvaluation
extends Object
implements Function<Object>, Serializable

Tail recursion for functions. If the Function returns another function of type functionType, that function is executed. Functions are executed until a non function value or a function of a type other than that expected is returned.

See Also:
Serialized Form

Constructor Summary
RecursiveEvaluation(Function<?> function)
          Create a new RecursiveEvaluation.
RecursiveEvaluation(Function<?> function, Class<?> functionType)
          Create a new RecursiveEvaluation.
 
Method Summary
 boolean equals(Object obj)
          Indicates whether some other object is "equal to" this functor.
 Object evaluate()
          Evaluate this function.
 int hashCode()
          Returns a hash code for this functor adhering to the general Object.hashCode contract.
 
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
 

Constructor Detail

RecursiveEvaluation

public RecursiveEvaluation(Function<?> function)
Create a new RecursiveEvaluation. Recursion will continue while the returned value is of the same runtime class as function.

Parameters:
function - initial, potentially recursive Function

RecursiveEvaluation

public RecursiveEvaluation(Function<?> function,
                           Class<?> functionType)
Create a new RecursiveEvaluation.

Parameters:
function - initial, potentially recursive Function
functionType - as long as result is an instance, keep processing.
Method Detail

evaluate

public final Object evaluate()
Evaluate this function.

Specified by:
evaluate in interface Function<Object>
Returns:
the T result of this evaluation

equals

public final boolean equals(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 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 Object
Returns:
a hash code for this functor
See Also:
Functor.equals(java.lang.Object)


Copyright © 2003-2011 The Apache Software Foundation. All Rights Reserved.