org.apache.commons.workflow.core
Class WhileStep

java.lang.Object
  org.apache.commons.workflow.base.BaseStep
      org.apache.commons.workflow.base.DescriptorStep
          org.apache.commons.workflow.base.BaseBlock
              org.apache.commons.workflow.core.WhileStep

All Implemented Interfaces:

org.apache.commons.workflow.Block, org.apache.commons.workflow.Descriptors, org.apache.commons.workflow.Iterator, org.apache.commons.workflow.Owner, org.apache.commons.workflow.Step

Direct Known Subclasses:

WhileAnyStep, WhileNotAnyStep, WhileNotStep

public class WhileStep

extends BaseBlock

implements org.apache.commons.workflow.Iterator

Repeatedly evaluate the properties specified by the associated Descriptors, and execute the nested Steps if and only if ALL of them evaluate to a positive result. To avoid non-deterministic evaluation stack behavior, all of the specified Descriptors are always evaluated exactly once.

Version:

$Revision: 1.3 $ $Date: 2004/02/28 03:35:54 $

Field Summary

Fields inherited from class org.apache.commons.workflow.base.BaseBlock

firstStep, lastStep

Fields inherited from class org.apache.commons.workflow.base.DescriptorStep

descriptors

Fields inherited from class org.apache.commons.workflow.base.BaseStep

id, nextStep, owner, previousStep

Constructor Summary

WhileStep()
Construct a default instance of this Step.

WhileStep(java.lang.String id)
Construct an instance of this Step with the specified identifier.

WhileStep(java.lang.String id, org.apache.commons.workflow.Descriptor descriptor)
Construct a fully configured instance of this Step.

Method Summary

protected boolean	evaluate(org.apache.commons.workflow.Context context) Evaluate the condition specified by the Descriptors associated with this Block, and return the resulting boolean value.
protected void	initial(org.apache.commons.workflow.Context context) Process the initial entry into this Block.
protected void	subsequent(org.apache.commons.workflow.Context context, org.apache.commons.workflow.BlockState state) Process the return from nested execution of the Steps assocaited with this Block.
java.lang.String	toString() Render a string representation of this Step.

Methods inherited from class org.apache.commons.workflow.base.BaseBlock

addStep, clearSteps, execute, findStep, getFirstStep, getLastStep, getSteps, setSteps, state

Methods inherited from class org.apache.commons.workflow.base.DescriptorStep

addDescriptor, findDescriptors, removeDescriptor

Methods inherited from class org.apache.commons.workflow.base.BaseStep

getId, getNextStep, getOwner, getPreviousStep, setId, setNextStep, setOwner, setPreviousStep

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.commons.workflow.Owner

addStep, clearSteps, findStep, getFirstStep, getLastStep, getSteps, setSteps

Methods inherited from interface org.apache.commons.workflow.Step

execute, getId, getNextStep, getOwner, getPreviousStep, setId, setNextStep, setOwner, setPreviousStep

Constructor Detail

WhileStep

public WhileStep()

Construct a default instance of this Step.

WhileStep

public WhileStep(java.lang.String id)

Construct an instance of this Step with the specified identifier.

Parameters:

id - Step identifier

WhileStep

public WhileStep(java.lang.String id,
                 org.apache.commons.workflow.Descriptor descriptor)

Construct a fully configured instance of this Step.

Parameters:

id - Step identifier of this step

descriptor - Initial descriptor to be added

Method Detail

toString

public java.lang.String toString()

Render a string representation of this Step.

evaluate

protected boolean evaluate(org.apache.commons.workflow.Context context)

Evaluate the condition specified by the Descriptors associated with this Block, and return the resulting boolean value.

Overrides:

evaluate in class BaseBlock

Parameters:

context - Context within which to evaluate the descriptors

initial

protected void initial(org.apache.commons.workflow.Context context)

Process the initial entry into this Block.

Overrides:

initial in class BaseBlock

Parameters:

context - Context within which to evaluate the condition

subsequent

protected void subsequent(org.apache.commons.workflow.Context context,
                          org.apache.commons.workflow.BlockState state)

Process the return from nested execution of the Steps assocaited with this Block.

Overrides:

subsequent in class BaseBlock

Parameters:

context - Context within which to evaluate the condition

state - BlockState for our block