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
OutputFilegetMasterDocument()
Get the master document
Iteratoriterator()
Gets an Iterator to access all files in the ConverterResult.
voidwrite(File dir)
Write all files of the ConverterResult to a directory.

Method Detail

getMasterDocument

public OutputFile getMasterDocument()
Get the master document

Returns: OutputFile the master document

iterator

public Iterator iterator()
Gets an Iterator to access all files in the ConverterResult. This includes the master document.

Returns: an Iterator of all files

write

public void write(File dir)
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