Class WhileDoProcedure

java.lang.Object

org.apache.commons.functor.core.composite.AbstractLoopProcedure

org.apache.commons.functor.core.composite.WhileDoProcedure

All Implemented Interfaces:

Serializable, Runnable, Functor, NullaryFunctor, Procedure

public class WhileDoProcedure
extends AbstractLoopProcedure

A Procedure implementation of a while loop. Given a Predicate c and an Procedure p, runs while(c.test()) { p.run(); }.

Note that although this class implements Serializable, a given instance will only be truly Serializable if all the underlying functors are. Attempts to serialize an instance whose delegates are not all Serializable will result in an exception.

Version:

$Revision$ $Date$

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private static final long	serialVersionUID	serialVersionUID declaration.

Constructor Summary

Constructors

Constructor	Description
WhileDoProcedure(Predicate condition, Procedure action)	Create a new WhileDoProcedure.

Method Summary

Modifier and Type	Method	Description
void	run()	Execute this procedure.
String	toString()	Returns a human readable description of this functor.

Methods inherited from class AbstractLoopProcedure

equals, getAction, getCondition, hashCode, hashCode

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

serialVersionUID

private static final long serialVersionUID

serialVersionUID declaration.

See Also:

• Constant Field Values

Constructor Details

WhileDoProcedure

public WhileDoProcedure(Predicate condition,
 Procedure action)

Create a new WhileDoProcedure.

Parameters:

condition - while

action - to do

Method Details

run

public void run()

Execute this procedure.

toString

public String toString()

Returns a human readable description of this functor. Implementators are strongly encouraged but not strictly required to override the default Object implementation of this method.

Specified by:

toString in interface Functor

Overrides:

toString in class AbstractLoopProcedure

Returns:

a human readable description of this functor