Interface ExportableDocument
-
- All Known Implementing Classes:
DefaultPhylogenyDocument
,DefaultSameTaxaTreesDocument
,DefaultTreeDocument
public interface ExportableDocument
Interface implemented by plugin documents that wish to implemenet a specialized export. Geneious provides a default export for standard document types (Sequences, Trees, etc) when appropriate.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
ExportableDocument.Format
Current exportable formats.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
canExport(ExportableDocument.Format format)
Check if a format is supported by document.boolean
export(ExportableDocument.Format format, java.io.OutputStream to)
Export a document.
-
-
-
Method Detail
-
canExport
boolean canExport(ExportableDocument.Format format)
Check if a format is supported by document.- Parameters:
format
- export format- Returns:
- true if format is supported.
-
export
boolean export(ExportableDocument.Format format, java.io.OutputStream to) throws java.io.IOException
Export a document.- Parameters:
format
- format to exportto
- output document to this stream.- Returns:
- true when file exported successfully, false otherwise.
- Throws:
java.io.IOException
- if the OutputStream can't be written to for any reason
-
-