kexcel-dsl/io.kexcel.driver/ExcelDriver

ExcelDriver

interface ExcelDriver

Strategy interface for interacting with different Excel libraries.

This interface abstracts the core operations of Excel generation, allowing the DSL to remain agnostic of the underlying engine (e.g., Apache POI, FastExcel).

Implementations must handle the lifecycle of workbooks, sheets, and rows in a streaming-compatible way.

Thread Safety: Implementations of this interface are generally not thread-safe. Synchronization should be handled at the DSL or application level.

See also

Inheritors

FastExcelDriver

Functions

abstract fun applyOptions(options: WorkbookOptions)

Applies configuration options to the workbook.

abstract fun finishRow()

Finalize the current row.

abstract fun finishSheet()

Finalize the current sheet.

abstract fun finishWorkbook()

Finalize the workbook, write to the output stream, and release resources.

abstract fun mergeCells(firstRow: Int, lastRow: Int, firstCol: Int, lastCol: Int)

Merge a range of cells into one.

abstract fun nativeSheet(): Any?

Returns the currently active native sheet object.

abstract fun nativeWorkbook(): Any?

Returns the underlying native workbook object.

abstract fun setColumnWidth(col: Int, width: Int)

Set the width of a specific column.

abstract fun startRow(rowNum: Int, height: Double? = null)

Start a new row at the specified rowNum.

abstract fun startSheet(name: String)

Create a new sheet with the given name.

abstract fun startWorkbook(outputStream: OutputStream)

Initialize the workbook and associate it with the provided outputStream.

abstract fun writeCell(col: Int, value: Any?, style: ExcelStyle? = null, link: String? = null)

Write a value to a specific cell in the current row.

abstract fun writeFormula(col: Int, formula: String, style: ExcelStyle? = null)

Write a formula to a specific cell in the current row.