org.apache.commons.workflow.core
Class PutStep

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

All Implemented Interfaces:

org.apache.commons.workflow.Descriptors, org.apache.commons.workflow.Step

public class PutStep

extends DescriptorStep

For each associated Descriptor, pop the top value from the evaluation stack, and store it as specified by that Descriptor, in the order that descriptors are listed.

Version:

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

Field Summary

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

PutStep()
Construct a default instance of this Step.

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

PutStep(java.lang.String id, org.apache.commons.workflow.Descriptor descriptor)
Construct an instance of this Step with the specified identifier and associated Descriptor.

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.

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, toString, wait, wait, wait

Constructor Detail

PutStep

public PutStep()

Construct a default instance of this Step.

PutStep

public PutStep(java.lang.String id)

Construct an instance of this Step with the specified identifier.

Parameters:

id - Step identifier

PutStep

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

Construct an instance of this Step with the specified identifier and associated Descriptor.

Parameters:

id - Step identifier

descriptor - Initial descriptor

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