org.apache.commons.workflow.core
Class LoadStep

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

All Implemented Interfaces:

org.apache.commons.workflow.Step

public class LoadStep

extends BaseStep

Load a class with the specified name from the specified class loader, and push the corresponding java.lang.Class object onto the evaluation stack.

Supported Attributes:

• name - The fully qualified name of the Java class to be loaded. If not specified, the top of the evaluation stack is popped, converted to a String (if necessary), and used as the name of the class to be loaded.
• thread - Should the class be loaded from the current Thread's context class loader? (Default is to load from the same class loader that loaded this class).

Version:

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

Field Summary

protected java.lang.String	name The class name to be loaded.
protected boolean	thread Load from the thread context class loader?

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

id, nextStep, owner, previousStep

Constructor Summary

LoadStep()
Construct a default instance of this Step.

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

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

LoadStep(java.lang.String id, java.lang.String name, boolean thread)
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	getName()
boolean	getThread()
void	setName(java.lang.String name)
void	setThread(boolean thread)
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

name

protected java.lang.String name

The class name to be loaded.

thread

protected boolean thread

Load from the thread context class loader?

Constructor Detail

LoadStep

public LoadStep()

Construct a default instance of this Step.

LoadStep

public LoadStep(java.lang.String id)

Construct an instance of this Step with the specified identifier.

Parameters:

id - Step identifier

LoadStep

public LoadStep(java.lang.String id,
                java.lang.String name)

Construct a fully configured instance of this Step.

Parameters:

id - Step identifier

name - Class name

LoadStep

public LoadStep(java.lang.String id,
                java.lang.String name,
                boolean thread)

Construct a fully configured instance of this Step.

Parameters:

id - Step identifier

name - Class name

thread - Load from thread context class loader?

Method Detail

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

getThread

public boolean getThread()

setThread

public void setThread(boolean thread)

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.