You are reading the documentation of sheetsmith 1.0.x.See the latest version (1.0.x)
Installation
Requirements
Section titled “Requirements”| Requirement | Value |
|---|---|
| Java | 17 or later |
| Spring Boot | 4.x, only for the Spring Boot integration |
| Apache POI | brought transitively by sheetsmith-core (POI 5.5.1 for sheetsmith 1.0.0) |
| Output format | .xlsx (Office Open XML) |
Modules and coordinates
Section titled “Modules and coordinates”The library is published as three Maven artifacts under the group cloud.baldilorenzo.
| Artifact | Content | Depends on Spring |
|---|---|---|
sheetsmith-core |
Annotations, metadata extraction and validation, style resolution, presets, converters, workbook writing. | No |
sheetsmith-spring-boot-autoconfigure |
The auto-configuration: the Sheetsmith bean, the sheetsmith.* properties, the Spring converter factory, the startup validator. |
Yes |
sheetsmith-spring-boot-starter |
No code. It brings the two modules above and spring-boot-starter. |
Yes |
Which artifact to import.
- A Spring Boot application imports only the starter:
<dependency> <groupId>cloud.baldilorenzo</groupId> <artifactId>sheetsmith-spring-boot-starter</artifactId> <version>1.0.0</version></dependency>- Any other Java application imports only the core:
<dependency> <groupId>cloud.baldilorenzo</groupId> <artifactId>sheetsmith-core</artifactId> <version>1.0.0</version></dependency>With Gradle, the coordinates are the same: implementation("cloud.baldilorenzo:sheetsmith-spring-boot-starter:1.0.0") or implementation("cloud.baldilorenzo:sheetsmith-core:1.0.0").
The sheetsmith-spring-boot-autoconfigure artifact is not meant to be imported directly.
Packages
Section titled “Packages”| Package | Content |
|---|---|
cloud.baldilorenzo.sheetsmith |
The generator, the sheet data, the application defaults, the document properties and the exceptions. |
cloud.baldilorenzo.sheetsmith.annotation |
The annotations that describe a sheet class. |
cloud.baldilorenzo.sheetsmith.style |
The enums used as style attribute values, and the presets. |
cloud.baldilorenzo.sheetsmith.convert |
The converter contract and the cell values. |
cloud.baldilorenzo.sheetsmith.autoconfigure |
The Spring Boot auto-configuration (in sheetsmith-spring-boot-autoconfigure). |
cloud.baldilorenzo.sheetsmith.internal and subpackages |
Implementation. Not part of the API: see Appendix A. |