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

Class RecursiveEvaluation

  • All Implemented Interfaces:
    java.io.Serializable, Function<java.lang.Object>, Functor, NullaryFunctor
    public class RecursiveEvaluation
extends java.lang.Object
implements Function<java.lang.Object>, java.io.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

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private Function<?> function
      The initial, potentially recursive Function.
      private java.lang.Class<?> functionType
      The initial recursive Function type.
      private static long serialVersionUID
      serialVersionUID declaration.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)
      Indicates whether some other object is "equal to" this functor.
      java.lang.Object evaluate()
      Evaluate this function.
      private static java.lang.Class<?> getClass​(Function<?> f)
      Get the class of the specified object, or null if o is null.
      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

    • Field Detail

      • serialVersionUID

        private static final long serialVersionUID
        serialVersionUID declaration.
        See Also:
        Constant Field Values

      • functionType

        private final java.lang.Class<?> functionType
        The initial recursive Function type.

      • function

        private Function<?> function
        The initial, potentially recursive Function.

    • 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,
                           java.lang.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 java.lang.Object evaluate()
        Evaluate this function.
        Specified by:
        evaluate in interface Function<java.lang.Object>
        Returns:
        the T result of this evaluation

      • equals

        public final 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)

      • getClass

        private static java.lang.Class<?> getClass​(Function<?> f)
        Get the class of the specified object, or null if o is null.
        Parameters:
        f - Object to check
        Returns:
        Class found