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

java.lang.Object
  org.apache.commons.functor.core.algorithm.DoWhile

All Implemented Interfaces:

Serializable, Runnable, Functor, NullaryFunctor, Procedure

public class DoWhile
extends Object

Do-while algorithm (test after).

Version:

$Revision: 1170319 $ $Date: 2011-09-13 21:39:33 +0200 (Tue, 13 Sep 2011) $

See Also:

Serialized Form

Constructor Summary

DoWhile(Procedure body, Predicate test)
Create a new DoWhile.

Method Summary

boolean	equals(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.
void	run() Execute this procedure.

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

DoWhile

public DoWhile(Procedure body,
               Predicate test)

Create a new DoWhile.

Parameters:

body - to execute

test - whether to keep going

Method Detail

run

public final void run()

Execute this procedure.

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:

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)