org.apache.commons.workflow.io
Class WriteStep

java.lang.Object
  extended by org.apache.commons.workflow.base.BaseStep
      extended by org.apache.commons.workflow.io.WriteStep
All Implemented Interfaces:
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:

DESIGN QUESTION - What about binary content?

Version:
$Revision: 155475 $ $Date: 2005-02-26 13:31:11 +0000 (Sat, 26 Feb 2005) $
Author:
Craig R. McClanahan

Field Summary
protected  String encoding
          The character encoding used to write the contents of this file.
protected  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(String id)
          Construct an instance of this Step with the specified identifier.
WriteStep(String id, String encoding, String file)
          Construct a fully configured instance of this Step.
 
Method Summary
 void execute(Context context)
          Perform the executable actions related to this Step, in the context of the specified Context.
 String getEncoding()
           
 String getFile()
           
 void setEncoding(String encoding)
           
 void setFile(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 String encoding
The character encoding used to write the contents of this file.


file

protected 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(String id)
Construct an instance of this Step with the specified identifier.

Parameters:
id - Step identifier

WriteStep

public WriteStep(String id,
                 String encoding,
                 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 String getEncoding()

setEncoding

public void setEncoding(String encoding)

getFile

public String getFile()

setFile

public void setFile(String file)

execute

public void execute(Context context)
             throws StepException
Perform the executable actions related to this Step, in the context of the specified Context.

Specified by:
execute in interface Step
Specified by:
execute in class BaseStep
Parameters:
context - The Context that is tracking our execution state
Throws:
StepException - if a processing error has occurred


Copyright © 2001-2010 The Apache Software Foundation. All Rights Reserved.