Package io.keikai.range

Interface SExporter

All Known Implementing Classes:

AbstractExporter, PdfExporter, RustHtmlExporter, RustPdfExporter

public interface SExporter

An exporter can export a book model to a output stream or file.

Since:

3.5.0

Author:

dennis

Method Summary

Modifier and Type	Method	Description
void	export(SBook book, File file)	Export a book
default void	export(SBook book, File file, ExportOptions options)	Export a book to a file applying the given ExportOptions.
void	export(SBook book, OutputStream fos)	Export a book
default void	export(SBook book, OutputStream fos, ExportOptions options)	Export a book applying the given ExportOptions (KEIKAI-832).

Method Details

export

void export(SBook book,
 OutputStream fos)
     throws IOException

Export a book

Parameters:

book - the book to export

fos - the output stream to store data

Throws:

IOException

export

void export(SBook book,
 File file)
     throws IOException

Export a book

Parameters:

book - the book to export

file - the output file to store data

Throws:

IOException

export

default void export(SBook book,
 OutputStream fos,
 ExportOptions options)
             throws IOException

Export a book applying the given ExportOptions (KEIKAI-832).

The default implementation honors only the no-op case: with null or default options it delegates to export(SBook, OutputStream); any other options throw UnsupportedOperationException. Exporters that support customization (currently XLSX/XLSM) override this method.

Parameters:

book - the book to export

fos - the output stream to store data

options - the export customizations; null means defaults

Throws:

IOException - on I/O failure

Since:

7.0.0

export

default void export(SBook book,
 File file,
 ExportOptions options)
             throws IOException

Export a book to a file applying the given ExportOptions. Convenience wrapper around export(SBook, OutputStream, ExportOptions).

Parameters:

book - the book to export

file - the output file to store data

options - the export customizations; null means defaults

Throws:

IOException - on I/O failure

Since:

7.0.0