Package writer2latex.api
Interface OutputFile
- All Known Implementing Classes:
BibTeXDocument
,BinaryGraphicsDocument
,ContainerWriter
,CssDocument
,DOMDocument
,EPUBWriter
,LaTeXDocument
,NCXWriter
,OPFWriter
,ResourceDocument
,XhtmlDocument
public interface OutputFile
An
OutputFile
represents a single file in a
ConverterResult
, which is output from a Converter
implementation.-
Method Summary
Modifier and TypeMethodDescriptionReturns the file name of theOutputFile
.Get the MIME type of theOutputFile
.boolean
Test whether this document is part of the main document flow (master documents) or an auxiliary documentvoid
write
(OutputStream os) Writes theOutputFile
to anOutputStream
.
-
Method Details
-
write
Writes theOutputFile
to anOutputStream
.- Parameters:
os
-OutputStream
to which the content should be written- Throws:
IOException
- if any I/O error occurs
-
getFileName
String getFileName()Returns the file name of theOutputFile
. This includes the file extension and may also include a relative path, always using / as separator.- Returns:
- the file name of this
OutputFile
-
getMIMEType
String getMIMEType()Get the MIME type of theOutputFile
.- Returns:
- string representation of the MIME type
-
isMasterDocument
boolean isMasterDocument()Test whether this document is part of the main document flow (master documents) or an auxiliary document- Returns:
- true if this document is a master document
-