org.apache.commons.workflow.core
Class BreakStep

java.lang.Object
  org.apache.commons.workflow.base.BaseStep
      org.apache.commons.workflow.core.BreakStep

All Implemented Interfaces:

org.apache.commons.workflow.Step

public class BreakStep

extends BaseStep

Locate the closest surrounding Iterator, set the nesting control to false, and transfer control to the Iterator.

Version:

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

Field Summary

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

id, nextStep, owner, previousStep

Constructor Summary

BreakStep()
Construct a default instance of this Step.

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

Method Summary

void	execute(org.apache.commons.workflow.Context context) Perform the executable actions related to this Step, in the context of the specified Context.
java.lang.String	toString() Render a string representation of this Step.

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

Constructor Detail

BreakStep

public BreakStep()

Construct a default instance of this Step.

BreakStep

public BreakStep(java.lang.String id)

Construct an instance of this Step with the specified identifier.

Parameters:

id - Step identifier

Method Detail

execute

public void execute(org.apache.commons.workflow.Context context)
             throws org.apache.commons.workflow.StepException

Perform the executable actions related to this Step, in the context of the specified Context.

Specified by:

execute in interface org.apache.commons.workflow.Step

Specified by:

execute in class BaseStep

Parameters:

context - The Context that is tracking our execution state

Throws:

org.apache.commons.workflow.StepException - if a processing error has occurred

toString

public java.lang.String toString()

Render a string representation of this Step.