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

Class PredicatedLoop

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Runnable, Functor, NullaryFunctor, Procedure
    Direct Known Subclasses:
    DoUntil, DoWhile, UntilDo, WhileDo
    abstract class PredicatedLoop
extends java.lang.Object
implements Procedure, java.io.Serializable
    Base class for predicated procedure algorithms.
    Version:
    $Revision$ $Date$

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private Procedure body
      The procedure body to execute.
      private static long serialVersionUID
      serialVersionUID declaration.
      private Predicate test
      The test wether to keep going.

    • Method Summary

      All 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.
      protected Procedure getBody()
      Get the body of this loop.
      protected Predicate getTest()
      Get the test for this loop.
      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.Procedure

        run

    • Field Detail

      • serialVersionUID

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

      • body

        private final Procedure body
        The procedure body to execute.

      • test

        private final Predicate test
        The test wether to keep going.

    • Constructor Detail

      • PredicatedLoop

        protected PredicatedLoop​(Procedure body,
                         Predicate test)
        Create a new PredicatedLoop.
        Parameters:
        body - to execute
        test - whether to keep going

    • Method Detail

      • getBody

        protected Procedure getBody()
        Get the body of this loop.
        Returns:
        Procedure

      • getTest

        protected Predicate getTest()
        Get the test for this loop.
        Returns:
        Predicate

      • 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)