Package writer2latex.api

Interface ConverterResult

public interface ConverterResult
A ConverterResult represent a document, which is the result of a conversion performed by a Converterimplementation.

  • Method Summary

    Modifier and Type
    Method
    Description
    Iterator<OutputFile>
    iterator()
    Gets an Iterator to access all files in the ConverterResult.
    void
    write(File dir)
    Write all files of the ConverterResult to a directory.

  • Method Details

    • iterator

      Iterator<OutputFile> iterator()
      Gets an Iterator to access all files in the ConverterResult. The iterator will return the master documents first in logical order (starting with the primary master document)
      Returns:
      an Iterator of all files

    • write

      void write(File dir) throws IOException
      Write all files of the ConverterResult to a directory. Subdirectories are created as required by the individual OutputFiles.
      Parameters:
      dir - the directory to write to (this directory must exist). If the parameter is null, the default directory is used
      Throws:
      IOException - if the directory does not exist or one or more files could not be written