<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet href="../plugin.xsl" type="text/xsl"?>
<plugin name="FileWriter">
  <object class="org.ow2.isac.plugin.filewriter.SessionObject">
    <params>
      <param name="charset" type="String" />
    </params>
    <help>This plug-in supports writing data to a local file, either in overwriting or appending mode. This plug-in provides four variables: pathname (the full path to the file, including the file name), dirname (the path to the directory holding this file), basename (just the name of the file without its directory's path) and length (the file size in bytes).</help>
  </object>
  <control name="open" number="9">
    <params>
      <param name="append" type="String" />
      <param name="path" type="String" />
    </params>
    <help>Opens a file for writing data, with the provided path name. Both absolute and relative path names are supported.
The file is created if it does not exist already.
If it already exists, its current content is either overwritten (overwrite option) or kept (append option).</help>
  </control>
  <control name="write" number="2">
    <params>
      <param name="string" type="String" />
    </params>
    <help>Writes the provided string to the currently open file.</help>
  </control>
  <control name="writeln" number="3">
    <params>
      <param name="string" type="String" />
    </params>
    <help>Writes the provided string to the currently open file, and terminates current line.</help>
  </control>
  <control name="newline" number="4">
    <params />
    <help>Terminates current line.</help>
  </control>
  <control name="flush" number="5">
    <params />
    <help>Flushes possibly unwritten data to the file system.</help>
  </control>
  <control name="close" number="6">
    <params />
    <help>Closes current file, flushing possibly unwritten data. Any further writing to the file requires to re-open it.</help>
  </control>
  <test name="isOpen" number="7">
    <params />
    <help>True when a file has been successfully open or created for writing, false otherwise.</help>
  </test>
  <test name="isNotOpen" number="8">
    <params />
    <help>True if no file is currently open for writing, false otherwise.</help>
  </test>
  <test name="exists" number="10">
    <params>
      <param name="path" type="String" />
    </params>
    <help>True if the designated file exists, false otherwise.</help>
  </test>
  <test name="existsNot" number="11">
    <params>
      <param name="path" type="String" />
    </params>
    <help>True if the designated file does not exists, false otherwise.</help>
  </test>
</plugin>

