org.apache.commons.workflow.io
Class WriteStep

java.lang.Object
  org.apache.commons.workflow.base.BaseStep
      org.apache.commons.workflow.io.WriteStep

All Implemented Interfaces:

org.apache.commons.workflow.Step

public class WriteStep

extends BaseStep

Pop the top value from the evaluation stack, and write its contents as a string to the specified file in the filesystem (replacing any previous contents in that file).

Supported Attributes:

• encoding - Character encoding in which to write the characters to the specified file, or omitted for the platform default encoding.
• file - Relative or absolute operating system pathname whose contents are to be written.

DESIGN QUESTION - What about binary content?

Version:

$Revision: 1.4 $ $Date: 2004/02/28 03:35:55 $

Field Summary

protected java.lang.String	encoding The character encoding used to write the contents of this file.
protected java.lang.String	file The relative or absolute pathname of the operating system file.

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

id, nextStep, owner, previousStep

Constructor Summary

WriteStep()
Construct a default instance of this Step.

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

WriteStep(java.lang.String id, java.lang.String encoding, java.lang.String file)
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	getEncoding()
java.lang.String	getFile()
void	setEncoding(java.lang.String encoding)
void	setFile(java.lang.String file)

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

Field Detail

encoding

protected java.lang.String encoding

The character encoding used to write the contents of this file.

file

protected java.lang.String file

The relative or absolute pathname of the operating system file.

Constructor Detail

WriteStep

public WriteStep()

Construct a default instance of this Step.

WriteStep

public WriteStep(java.lang.String id)

Construct an instance of this Step with the specified identifier.

Parameters:

id - Step identifier

WriteStep

public WriteStep(java.lang.String id,
                 java.lang.String encoding,
                 java.lang.String file)

Construct a fully configured instance of this Step.

Parameters:

id - Step identifier

encoding - Character encoding to use

file - Relative or absolute pathname

Method Detail

getEncoding

public java.lang.String getEncoding()

setEncoding

public void setEncoding(java.lang.String encoding)

getFile

public java.lang.String getFile()

setFile

public void setFile(java.lang.String file)

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