org.apache.commons.workflow.core
Class StringStep

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

All Implemented Interfaces:

org.apache.commons.workflow.Step

public class StringStep

extends BaseStep

Push the specified String value onto the top of the evaluation stack.

Supported Attributes:

• value - String value to be pushed.

Version:

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

Field Summary

protected java.lang.String

value The string value to be pushed.

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

id, nextStep, owner, previousStep

Constructor Summary

StringStep()
Construct a default instance of this Step.

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

StringStep(java.lang.String id, java.lang.String value)
Construct a fully configured instance of this Step.

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	getValue()
void	setValue(java.lang.String value)
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

Field Detail

value

protected java.lang.String value

The string value to be pushed.

Constructor Detail

StringStep

public StringStep()

Construct a default instance of this Step.

StringStep

public StringStep(java.lang.String id)

Construct an instance of this Step with the specified identifier.

Parameters:

id - Step identifier

StringStep

public StringStep(java.lang.String id,
                  java.lang.String value)

Construct a fully configured instance of this Step.

Parameters:

id - Step identifier

value - String value to be pushed

Method Detail

getValue

public java.lang.String getValue()

setValue

public void setValue(java.lang.String value)

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.