writer2latex.api
Interface ConverterResult

All Known Implementing Classes:

ConvertData

public interface ConverterResult

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

Method Summary

OutputFile	getMasterDocument() Get the master document
java.util.Iterator	iterator() Gets an Iterator to access all files in the ConverterResult.
void	write(java.io.File dir) Write all files of the ConverterResult to a directory.

Method Detail

getMasterDocument

OutputFile getMasterDocument()

Get the master document

Returns:

OutputFile the master document

iterator

java.util.Iterator iterator()

Gets an Iterator to access all files in the ConverterResult. This includes the master document.

Returns:

an Iterator of all files

write

void write(java.io.File dir)
           throws java.io.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:

java.io.IOException - if the directory does not exist or one or more files could not be written