Skip to content
sheetsmith

Annotations

All annotations are in the package cloud.baldilorenzo.sheetsmith.annotation and are retained at runtime.

Annotation Target Purpose
@ExcelSheet class, record, interface Marks a sheet class and configures the table as a whole. Mandatory on every sheet class.
@ExcelColumn field, record component Exports a field as a column and configures it.
@ExcelStyle class (repeatable) Declares a named style.
@ExcelStyles class Container of repeated @ExcelStyle, generated by the compiler. Not written by hand.
@ExcelStyleSheet class Marks a class that holds shared named styles.
@HeaderStyles attribute value only Header slots, value of @ExcelSheet.header.
@BodyStyles attribute value only Body slots at table level, value of @ExcelSheet.body.
@ColumnStyles attribute value only Body slots of one column, value of @ExcelColumn.styles.

Each attribute below is documented with the same template: type, default, allowed values, effect, interactions with other attributes, related validation rules and an example.