Class PredicatedLoop

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

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      serialVersionUID declaration.
      See Also:

    • body

      private final Procedure body
      The procedure body to execute.

    • test

      private final Predicate test
      The test wether to keep going.

  • Constructor Details

    • PredicatedLoop

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

  • Method Details

    • 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(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:

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