Package writer2latex.api
Interface ConverterResult
-
- All Known Implementing Classes:
ConvertData
public interface ConverterResult
AConverterResult
represent a document, which is the result of a conversion performed by aConverter
implementation.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description OutputFile
getMasterDocument()
Get the master documentjava.util.Iterator
iterator()
Gets anIterator
to access all files in theConverterResult
.void
write(java.io.File dir)
Write all files of theConverterResult
to a directory.
-
-
-
Method Detail
-
getMasterDocument
OutputFile getMasterDocument()
Get the master document- Returns:
OutputFile
the master document
-
iterator
java.util.Iterator iterator()
Gets anIterator
to access all files in theConverterResult
. 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 theConverterResult
to a directory. Subdirectories are created as required by the individualOutputFile
s.- 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
-
-