Class census

Public API of sheetsmith-core

These types are the supported API. They are documented in the published Javadoc and follow the compatibility rules of the library versions.

Type	Package	Kind	Usable for
Sheetsmith	cloud.baldilorenzo.sheetsmith	interface	generating and validating; obtaining a builder
Sheetsmith.Builder	same	interface	configuring a generator
SheetData<T>	same	record	describing a sheet to generate
SheetsmithDefaults	same	record	application defaults
DocumentProperties	same	record	author and application of the files
SheetsmithException	same	sealed abstract class	catching every library exception
SheetsmithConfigurationException	same	final class	configuration errors
SheetsmithGenerationException	same	final class	data errors
ConfigurationError	same	record	one configuration error
ExcelSheet	cloud.baldilorenzo.sheetsmith.annotation	annotation	sheet class
ExcelColumn	same	annotation	column
ExcelStyle	same	annotation (repeatable)	named style; also holds the constant UNSET
ExcelStyles	same	annotation	container of ExcelStyle, compiler use
ExcelStyleSheet	same	annotation	style sheet
HeaderStyles	same	annotation	header slots
BodyStyles	same	annotation	body slots
ColumnStyles	same	annotation	column slots
Align	cloud.baldilorenzo.sheetsmith.style	enum	horizontal alignment
VerticalAlign	same	enum	vertical alignment
Border	same	enum	border lines
Fill	same	enum	fill patterns
Underline	same	enum	underline
Script	same	enum	superscript and subscript
Toggle	same	enum	three-state yes/no
TablePreset	same	enum	presets
CellConverter<T>	cloud.baldilorenzo.sheetsmith.convert	functional interface	converters
CellConverter.None	same	final class	marker, never used directly
CellConverterFactory	same	interface	creating field converters
CellValue	same	sealed interface	values written to cells
CellValue.Text, Numeric, Bool, Date, DateTime	same	records	forms of CellValue
CellValue.Blank	same	final class	the empty cell, singleton
ConversionContext	same	interface	where a value is written

Public API of sheetsmith-spring-boot-autoconfigure

Type	Kind	Usable for
SheetsmithAutoConfiguration	class	instantiated by Spring Boot only
SheetsmithProperties	record	reading the bound properties; toDefaults(), toDocumentProperties()
SheetsmithProperties.Formats	record	sheetsmith.formats.*
SheetsmithProperties.Document	record	sheetsmith.document.*
SheetsmithProperties.Validation	record	sheetsmith.validation.*
SpringConverterFactory	class	creating field converters from a Spring context, also in application-defined generators
SheetsmithStartupValidator	class	startup validation; registered automatically

sheetsmith-spring-boot-starter contains no classes.

Internal classes

The packages cloud.baldilorenzo.sheetsmith.internal, .internal.convert, .internal.metadata, .internal.style and .internal.write contain the implementation. Some of their classes are public because Java requires it across packages, but they are not part of the API: they are excluded from the published Javadoc, and they can change or disappear in any version, including patch versions. Applications must not use them.

Package	Classes	Responsibility
internal	DefaultSheetsmith	default implementation of Sheetsmith and of its builder
internal.convert	BuiltInConverters, ConverterRegistry, ConverterTypes, ConverterBinder, ReflectiveConverterFactory, SheetBinding	built-in converters, resolution, binding of converters to columns, default factory
internal.metadata	MetadataExtractor, MetadataValidator, MetadataCache, SheetMetadata, ColumnMetadata, StyleDefinition, ValueAccessor	reading and validating annotations, caching metadata, accessing values
internal.style	StyleAttributes, StyleResolver, StyleCache, PresetFactory, ColorUtils, OuterBorder, CellRole, PoiMapping	style model, cascade, presets, colour arithmetic, conversion to POI styles
internal.write	WorkbookWriter, SheetWriter, WorkbookSupplier, WritableSheet	creating, writing and releasing workbooks