Package io.github.dornol.excelkit.excel

Class ExcelWriter.InitOptions

java.lang.Object

io.github.dornol.excelkit.excel.ExcelWriter.InitOptions

Enclosing class:

ExcelWriter<T>

public static final class ExcelWriter.InitOptions
extends Object

Initialization options for ExcelWriter. Passed to the configurer given to ExcelWriter.create(Consumer).

These options are restricted to settings that cannot be changed after the underlying SXSSFWorkbook is constructed (currently just rowAccessWindowSize). All other configuration is available as fluent methods on ExcelWriter.

Since:

0.17.0

Method Summary

Modifier and Type	Method	Description
ExcelWriter.InitOptions	rowAccessWindowSize(int size)	Sets the number of rows kept in memory by the underlying SXSSFWorkbook.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

rowAccessWindowSize

public ExcelWriter.InitOptions rowAccessWindowSize(int size)

Sets the number of rows kept in memory by the underlying SXSSFWorkbook. Higher values use more memory but reduce disk I/O; lower values are the inverse. Defaults to 1000.

This must be set at construction time because POI's SXSSFWorkbook takes it as a constructor argument and does not support changing it afterwards.

Parameters:

size - row access window size (must be positive)

Returns:

this options object for chaining