|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.commons.workflow.base.BaseStep org.apache.commons.workflow.io.WriteStep
public class WriteStep
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:
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 |
---|
protected String encoding
protected String file
Constructor Detail |
---|
public WriteStep()
public WriteStep(String id)
id
- Step identifierpublic WriteStep(String id, String encoding, String file)
id
- Step identifierencoding
- Character encoding to usefile
- Relative or absolute pathnameMethod Detail |
---|
public String getEncoding()
public void setEncoding(String encoding)
public String getFile()
public void setFile(String file)
public void execute(Context context) throws StepException
execute
in interface Step
execute
in class BaseStep
context
- The Context that is tracking our execution state
StepException
- if a processing error has occurred
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |