Package io.keikai.api

Interface Exporter

All Known Implementing Classes:

ExporterImpl

public interface Exporter

Exporter for a book or a sheet.

Since:

3.0.0

Author:

dennis

Method Summary

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

Method Details

export

void export(Book book,
 OutputStream fos)
     throws IOException

Export book

Parameters:

book - the book to export

fos - the output stream to store data

Throws:

IOException

export

void export(Book book,
 File file)
     throws IOException

Export book

Parameters:

book - the book to export

file - the output file to store data

Throws:

IOException

export

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

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

The default implementation delegates to export(Book, OutputStream) when options is null or default, and otherwise throws UnsupportedOperationException. Exporters that support customization (currently XLSX/XLSM) override it.

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