kexcel-dsl/io.kexcel.core

Package-level declarations

Types

abstract class BaseScope(driver: ExcelDriver)

Base class for all Excel DSL builders, providing thread-safety checks.

class ColumnDef<T>(val header: String, val headerStyle: ExcelStyle? = null, val style: ExcelStyle? = null, val cellStyle: (T) -> ExcelStyle?? = null, val linkExtractor: (T) -> String?? = null, val valueExtractor: (T) -> Any?? = null, val formulaExtractor: (Int, T) -> String? = null)

Defines a column for the DataSheetScope.

DataSheetScope

class DataSheetScope<T>(driver: ExcelDriver, defaultStyle: ExcelStyle? = null) : BaseScope

Scope for DTO-based data sheets. Provides a declarative way to map a collection of items to Excel rows.

ExcelConcurrentWriteException

class ExcelConcurrentWriteException(message: String) : ExcelDslException

Thrown when concurrent write access is detected in the DSL builders.

ExcelConfigurationException

class ExcelConfigurationException(message: String) : ExcelDslException

Thrown when the DSL or engine is improperly configured.

ExcelDslException

sealed class ExcelDslException : RuntimeException

Base exception for all errors occurring within the Excel DSL.

ExcelDslMarker

@DslMarker

annotation class ExcelDslMarker

DSL Marker for the Excel DSL to prevent nested builder calls.

ExcelStreamingException

class ExcelStreamingException(message: String, cause: Throwable? = null) : ExcelDslException

Thrown when an error occurs during Excel streaming operations.

RowScope

class RowScope(driver: ExcelDriver) : BaseScope

Scope for creating a row.

SheetScope

class SheetScope(driver: ExcelDriver, defaultStyle: ExcelStyle? = null) : BaseScope

Scope for creating a sheet.

WorkbookScope

class WorkbookScope(driver: ExcelDriver) : BaseScope

Scope for creating a workbook.

Functions

excel

fun excel(output: OutputStream, driver: ExcelDriver = ExcelDriverFactory.autoDetect(), defaultStyle: ExcelStyle? = null, options: WorkbookOptions = WorkbookOptions(), init: WorkbookScope.() -> Unit)

Entry point for the Excel DSL.