Index
All Classes and Interfaces|All Packages|Serialized Form
A
- A3 - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelPrintSetup.PaperSize
-
A3 paper size.
- A4 - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelPrintSetup.PaperSize
-
A4 paper size.
- A5 - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelPrintSetup.PaperSize
-
A5 paper size.
- AbstractReadHandler<T> - Class in io.github.dornol.excelkit.core
-
Abstract base class for file read handlers (Excel, CSV).
- AbstractReadHandler(InputStream, Function<RowData, T>, Validator, String) - Constructor for class io.github.dornol.excelkit.core.AbstractReadHandler
-
Constructs a read handler in mapping mode for immutable object construction.
- AbstractReadHandler(InputStream, Supplier<T>, Validator, String) - Constructor for class io.github.dornol.excelkit.core.AbstractReadHandler
-
Constructs a read handler in setter mode by validating inputs and initializing a temporary file.
- accept(T, Cursor) - Method in interface io.github.dornol.excelkit.excel.WriteRowCallback
-
Called for each row processed during the Excel writing process.
- addDateFormat(String) - Static method in record class io.github.dornol.excelkit.core.CellData
-
Adds a custom date format pattern for
CellData.asLocalDate(). - addDateTimeFormat(String) - Static method in record class io.github.dornol.excelkit.core.CellData
-
Adds a custom date-time format pattern for
CellData.asLocalDateTime(). - afterAll(AfterDataWriter) - Method in class io.github.dornol.excelkit.excel.ExcelWriter
-
Registers a callback that writes custom content once on the last sheet after all data.
- afterData(CsvAfterDataWriter) - Method in class io.github.dornol.excelkit.csv.CsvWriter
-
Registers a callback that writes custom content after all data rows.
- afterData(AfterDataWriter) - Method in class io.github.dornol.excelkit.excel.ExcelSheetWriter
-
Registers a callback that writes content after all data rows.
- afterData(AfterDataWriter) - Method in class io.github.dornol.excelkit.excel.ExcelWriter
-
Registers a callback that writes custom content after all data rows on each sheet.
- afterData(AfterDataWriter) - Method in class io.github.dornol.excelkit.excel.TemplateListWriter
-
Registers a callback that writes content after all data rows.
- AfterDataWriter - Interface in io.github.dornol.excelkit.excel
-
A functional interface for writing custom content after data rows.
- alignment(HorizontalAlignment) - Method in class io.github.dornol.excelkit.excel.ColumnStyleConfig
-
Sets the column's horizontal text alignment.
- ALL - Enum constant in enum class io.github.dornol.excelkit.csv.CsvQuoting
-
Quote all fields unconditionally.
- apply(Object, T) - Method in interface io.github.dornol.excelkit.excel.CellColorFunction
-
Determines the background color for a cell.
- apply(T, Cursor) - Method in interface io.github.dornol.excelkit.core.RowFunction
-
Applies this function to the given row data and cursor.
- AREA - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelChartConfig.ChartType
-
Area chart.
- ARROWS_3 - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelConditionalRule.IconSetType
-
3 arrows icon set.
- ARROWS_4 - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelConditionalRule.IconSetType
-
4 arrows icon set.
- ARROWS_5 - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelConditionalRule.IconSetType
-
5 arrows icon set.
- as(Function<String, R>) - Method in record class io.github.dornol.excelkit.core.CellData
-
Converts the cell value using a custom conversion function.
- as(Function<String, R>, R) - Method in record class io.github.dornol.excelkit.core.CellData
-
Converts the cell value using a custom function, returning the given default if blank.
- asBigDecimal() - Method in record class io.github.dornol.excelkit.core.CellData
-
Converts the value to
BigDecimalwith full precision. - asBoolean() - Method in record class io.github.dornol.excelkit.core.CellData
-
Converts the value to a boolean.
- asBooleanOrNull() - Method in record class io.github.dornol.excelkit.core.CellData
-
Converts the value to a nullable
Boolean. - asDouble() - Method in record class io.github.dornol.excelkit.core.CellData
-
Converts the value to
Double. - asDouble(double) - Method in record class io.github.dornol.excelkit.core.CellData
-
Converts the cell value to
Double, returning the given default if blank. - asEnum(Class<E>) - Method in record class io.github.dornol.excelkit.core.CellData
-
Converts the value to an enum constant by name (case-insensitive).
- asFloat() - Method in record class io.github.dornol.excelkit.core.CellData
-
Converts the value to
Float. - asInt() - Method in record class io.github.dornol.excelkit.core.CellData
-
Converts the value to
Integer. - asInt(int) - Method in record class io.github.dornol.excelkit.core.CellData
-
Converts the cell value to
Integer, returning the given default if blank. - asLocalDate() - Method in record class io.github.dornol.excelkit.core.CellData
-
Converts the formatted value to
LocalDateusing multiple supported date formats. - asLocalDate(String) - Method in record class io.github.dornol.excelkit.core.CellData
-
Converts the value to
LocalDateusing the specified format. - asLocalDateTime() - Method in record class io.github.dornol.excelkit.core.CellData
-
Converts the formatted value to
LocalDateTimeusing multiple supported date-time formats. - asLocalDateTime(String) - Method in record class io.github.dornol.excelkit.core.CellData
-
Converts the value to
LocalDateTimeusing the specified format. - asLocalTime() - Method in record class io.github.dornol.excelkit.core.CellData
-
Converts the value to
LocalTimeusing ISO format (HH:mm:ss). - asLocalTime(String) - Method in record class io.github.dornol.excelkit.core.CellData
-
Converts the value to
LocalTimeusing the specified format. - asLong() - Method in record class io.github.dornol.excelkit.core.CellData
-
Converts the value to
Long. - asLong(long) - Method in record class io.github.dornol.excelkit.core.CellData
-
Converts the cell value to
Long, returning the given default if blank. - asNumber() - Method in record class io.github.dornol.excelkit.core.CellData
-
Parses the value as a
Numberusing the configured default locale. - asNumber(Locale) - Method in record class io.github.dornol.excelkit.core.CellData
-
Parses the value as a
Numberusing the given locale. - asString() - Method in record class io.github.dornol.excelkit.core.CellData
-
Returns the raw string as-is.
- asString(String) - Method in record class io.github.dornol.excelkit.core.CellData
-
Returns the string value, or the given default if blank.
- asZonedDateTime(String, ZoneId) - Method in record class io.github.dornol.excelkit.core.CellData
-
Converts the value to
ZonedDateTimeusing the specified format and time zone. - asZonedDateTime(ZoneId) - Method in record class io.github.dornol.excelkit.core.CellData
-
Converts the value to
ZonedDateTimeby parsing asLocalDateTimeand attaching the given time zone. - author() - Method in record class io.github.dornol.excelkit.excel.ExcelCellComment
-
Returns the value of the
authorrecord component. - author(String) - Method in record class io.github.dornol.excelkit.excel.ExcelCellComment
-
Returns a copy with the given author.
- autoFilter() - Method in class io.github.dornol.excelkit.excel.ExcelSheetWriter
-
Enables auto-filter on the header row.
- autoFilter(boolean) - Method in class io.github.dornol.excelkit.excel.ExcelSheetWriter
-
Enables or disables auto-filter on the header row.
- autoFilter(boolean) - Method in class io.github.dornol.excelkit.excel.ExcelWriter
-
Enables or disables auto-filter on the header row.
- autoWidthSampleRows(int) - Method in class io.github.dornol.excelkit.excel.ExcelSheetWriter
-
Sets the number of rows sampled for auto column width calculation.
- autoWidthSampleRows(int) - Method in class io.github.dornol.excelkit.excel.ExcelWriter
-
Sets the number of rows sampled for auto column width calculation.
- autoWidthSampleRows(int) - Method in class io.github.dornol.excelkit.excel.TemplateListWriter
-
Sets the number of rows sampled for auto column width calculation.
- average(String) - Method in class io.github.dornol.excelkit.excel.ExcelSummary
-
Adds an AVERAGE formula for the specified column.
- AVERAGE - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelSummary.Op
-
Average formula.
B
- B4 - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelPrintSetup.PaperSize
-
B4 paper size.
- B5 - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelPrintSetup.PaperSize
-
B5 paper size.
- backgroundColor(int, int, int) - Method in class io.github.dornol.excelkit.excel.ColumnStyleConfig
-
Sets the background color for this column's cells.
- backgroundColor(ExcelColor) - Method in class io.github.dornol.excelkit.excel.ColumnStyleConfig
-
Sets the background color for this column's cells using a preset color.
- BAR - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelChartConfig.ChartType
-
Bar chart.
- barDirection(ExcelChartConfig.BarDirection) - Method in class io.github.dornol.excelkit.excel.ExcelChartConfig
-
Sets the bar direction for bar charts.
- barGrouping(ExcelChartConfig.BarGrouping) - Method in class io.github.dornol.excelkit.excel.ExcelChartConfig
-
Sets the bar grouping mode for bar charts.
- beforeHeader(BeforeHeaderWriter) - Method in class io.github.dornol.excelkit.excel.ExcelSheetWriter
-
Registers a callback that writes content before the header row.
- beforeHeader(BeforeHeaderWriter) - Method in class io.github.dornol.excelkit.excel.ExcelWriter
-
Registers a callback that writes custom content before the column header row.
- BeforeHeaderWriter - Interface in io.github.dornol.excelkit.excel
-
A functional interface for writing custom content before the column header row.
- between(String, String, ExcelColor) - Method in class io.github.dornol.excelkit.excel.ExcelConditionalRule
-
Adds a rule: cell value between the given values (inclusive).
- BIG_DECIMAL_TO_DOUBLE - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelDataType
-
BigDecimal converted to double (2 decimal places).
- BIG_DECIMAL_TO_LONG - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelDataType
-
BigDecimal converted to long (no decimal).
- BLACK - Static variable in class io.github.dornol.excelkit.excel.ExcelColor
-
Black (0, 0, 0).
- BLUE - Static variable in class io.github.dornol.excelkit.excel.ExcelColor
-
Blue (0, 0, 255).
- bold(boolean) - Method in class io.github.dornol.excelkit.excel.ColumnStyleConfig
-
Sets whether this column's font should be bold.
- bold(boolean) - Method in class io.github.dornol.excelkit.excel.ExcelRichText.FontStyle
-
Sets bold styling.
- bold(String) - Method in class io.github.dornol.excelkit.excel.ExcelRichText
-
Appends bold text.
- bom(boolean) - Method in class io.github.dornol.excelkit.csv.CsvWriter
-
Sets whether to write a UTF-8 BOM at the start of the file.
- BOOLEAN_TO_YN - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelDataType
-
Boolean values are converted to "Y" or "N".
- border(ExcelBorderStyle) - Method in class io.github.dornol.excelkit.excel.ColumnStyleConfig
-
Sets the border style for this column's cells.
- borderBottom(ExcelBorderStyle) - Method in class io.github.dornol.excelkit.excel.ColumnStyleConfig
-
Sets the bottom border style for this column's cells.
- borderLeft(ExcelBorderStyle) - Method in class io.github.dornol.excelkit.excel.ColumnStyleConfig
-
Sets the left border style for this column's cells.
- borderRight(ExcelBorderStyle) - Method in class io.github.dornol.excelkit.excel.ColumnStyleConfig
-
Sets the right border style for this column's cells.
- borderTop(ExcelBorderStyle) - Method in class io.github.dornol.excelkit.excel.ColumnStyleConfig
-
Sets the top border style for this column's cells.
- BOTTOM - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelChartConfig.LegendPosition
-
Bottom position.
- bottomMargin(double) - Method in class io.github.dornol.excelkit.excel.ExcelPrintSetup
-
Sets the bottom margin.
- build() - Method in class io.github.dornol.excelkit.core.ExcelKitSchema.Builder
-
Builds the schema.
- build(InputStream) - Method in class io.github.dornol.excelkit.csv.CsvReader
-
Finalizes the configuration and builds a
CsvReadHandlerfor parsing the given CSV stream. - build(InputStream) - Method in class io.github.dornol.excelkit.excel.ExcelReader
-
Finalizes the configuration and builds an
ExcelReadHandlerfor parsing the given Excel stream. - builder() - Static method in class io.github.dornol.excelkit.core.ExcelKitSchema
-
Creates a new schema builder.
C
- categoryAxisTitle(String) - Method in class io.github.dornol.excelkit.excel.ExcelChartConfig
-
Sets the category axis (X-axis) title.
- categoryColumn(int) - Method in class io.github.dornol.excelkit.excel.ExcelChartConfig
-
Sets the category (X-axis) column index (0-based).
- cell(int, int, Object) - Method in class io.github.dornol.excelkit.excel.ExcelTemplateWriter
-
Writes a value to the specified cell by row and column index.
- cell(int, int, Object, CellStyle) - Method in class io.github.dornol.excelkit.excel.ExcelTemplateWriter
-
Writes a value with a custom style to the specified cell by row and column index.
- cell(String, Object) - Method in class io.github.dornol.excelkit.excel.ExcelTemplateWriter
-
Writes a value to the specified cell on the active sheet.
- cell(String, Object, CellStyle) - Method in class io.github.dornol.excelkit.excel.ExcelTemplateWriter
-
Writes a value with a custom style to the specified cell.
- cellColor(CellColorFunction<T>) - Method in class io.github.dornol.excelkit.excel.ColumnStyleConfig
-
Sets a per-cell conditional color function.
- CellColorFunction<T> - Interface in io.github.dornol.excelkit.excel
-
Function that determines the background color for an individual cell based on its value and row data.
- CellData - Record Class in io.github.dornol.excelkit.core
-
Represents a single cell's value read from an Excel file, along with its column index and formatted string content.
- CellData(int, String) - Constructor for record class io.github.dornol.excelkit.core.CellData
-
Validates and normalizes the cell data.
- charset(Charset) - Method in class io.github.dornol.excelkit.csv.CsvReader
-
Sets the character encoding for reading the CSV file.
- charset(Charset) - Method in class io.github.dornol.excelkit.csv.CsvWriter
-
Sets the character encoding for the output file.
- chart(Consumer<ExcelChartConfig>) - Method in class io.github.dornol.excelkit.excel.ExcelSheetWriter
-
Configures a chart to be added after data is written.
- chart(Consumer<ExcelChartConfig>) - Method in class io.github.dornol.excelkit.excel.ExcelWriter
-
Configures a chart to be added after all data is written.
- close() - Method in class io.github.dornol.excelkit.core.TempResourceContainer
-
Attempts to delete the temporary file and directory (if they exist).
- close() - Method in class io.github.dornol.excelkit.excel.ExcelTemplateWriter
-
Closes the underlying workbook if it has not been finished.
- close() - Method in class io.github.dornol.excelkit.excel.ExcelWorkbook
-
Closes the underlying workbook if it has not been finished.
- Closed hierarchy - Search tag in interface io.github.dornol.excelkit.core.FileHandler
- Section
- color(int, int, int) - Method in class io.github.dornol.excelkit.excel.ExcelRichText.FontStyle
-
Sets the font color using RGB values.
- color(ExcelColor) - Method in class io.github.dornol.excelkit.excel.ExcelRichText.FontStyle
-
Sets the font color using a predefined
ExcelColor. - column(String, RowFunction<T, Object>) - Method in class io.github.dornol.excelkit.csv.CsvWriter
-
Adds a new column to the CSV output using a row+cursor-based function.
- column(String, RowFunction<T, Object>) - Method in class io.github.dornol.excelkit.excel.ExcelSheetWriter
-
Adds a column using a row function with cursor support.
- column(String, RowFunction<T, Object>) - Method in class io.github.dornol.excelkit.excel.ExcelWriter
-
Adds a column with cursor access using an RowFunction.
- column(String, RowFunction<T, Object>) - Method in class io.github.dornol.excelkit.excel.TemplateListWriter
-
Adds a column using a row function with cursor support.
- column(String, RowFunction<T, Object>, Consumer<ColumnConfig<T>>) - Method in class io.github.dornol.excelkit.excel.ExcelSheetWriter
-
Adds a column using a row function with cursor support and additional configuration.
- column(String, RowFunction<T, Object>, Consumer<ColumnConfig<T>>) - Method in class io.github.dornol.excelkit.excel.TemplateListWriter
-
Adds a column using a row function with cursor support and additional configuration.
- column(String, RowFunction<T, Object>, Consumer<ExcelColumn.ExcelColumnBuilder<T>>) - Method in class io.github.dornol.excelkit.excel.ExcelWriter
-
Adds a column with cursor access and additional configuration.
- column(String, BiConsumer<T, CellData>) - Method in class io.github.dornol.excelkit.csv.CsvReader
-
Registers a name-based column mapping.
- column(String, BiConsumer<T, CellData>) - Method in class io.github.dornol.excelkit.excel.ExcelReader
-
Registers a name-based column mapping.
- column(String, Function<T, Object>) - Method in class io.github.dornol.excelkit.csv.CsvWriter
-
Adds a new column using a basic row-only function.
- column(String, Function<T, Object>) - Method in class io.github.dornol.excelkit.excel.ExcelSheetWriter
-
Adds a column using a simple function.
- column(String, Function<T, Object>) - Method in class io.github.dornol.excelkit.excel.ExcelWriter
-
Adds a column with default STRING type using a simple Function.
- column(String, Function<T, Object>) - Method in class io.github.dornol.excelkit.excel.TemplateListWriter
-
Adds a column using a simple function.
- column(String, Function<T, Object>, BiConsumer<T, CellData>) - Method in class io.github.dornol.excelkit.core.ExcelKitSchema.Builder
-
Adds a column definition to the schema.
- column(String, Function<T, Object>, BiConsumer<T, CellData>, Consumer<ExcelColumn.ExcelColumnBuilder<T>>) - Method in class io.github.dornol.excelkit.core.ExcelKitSchema.Builder
-
Adds a column definition with Excel write configuration.
- column(String, Function<T, Object>, Consumer<ColumnConfig<T>>) - Method in class io.github.dornol.excelkit.excel.ExcelSheetWriter
-
Adds a column with additional configuration.
- column(String, Function<T, Object>, Consumer<ColumnConfig<T>>) - Method in class io.github.dornol.excelkit.excel.TemplateListWriter
-
Adds a column with additional configuration.
- column(String, Function<T, Object>, Consumer<ExcelColumn.ExcelColumnBuilder<T>>) - Method in class io.github.dornol.excelkit.excel.ExcelWriter
-
Adds a column with additional configuration using a configurer consumer.
- column(BiConsumer<T, CellData>) - Method in class io.github.dornol.excelkit.csv.CsvReader
-
Registers a positional column mapping.
- column(BiConsumer<T, CellData>) - Method in class io.github.dornol.excelkit.excel.ExcelReader
-
Registers a positional column mapping.
- columnAt(int, BiConsumer<T, CellData>) - Method in class io.github.dornol.excelkit.csv.CsvReader
-
Registers an index-based column mapping.
- columnAt(int, BiConsumer<T, CellData>) - Method in class io.github.dornol.excelkit.excel.ExcelReader
-
Registers an index-based column mapping.
- ColumnConfig<T> - Class in io.github.dornol.excelkit.excel
-
Concrete column styling configuration used by
ExcelSheetWriterandTemplateListWriterfor their.column(name, fn, cfg -> ...)overloads. - ColumnConfig() - Constructor for class io.github.dornol.excelkit.excel.ColumnConfig
-
Creates a new column configuration with defaults.
- columnIf(String, boolean, RowFunction<T, Object>) - Method in class io.github.dornol.excelkit.csv.CsvWriter
-
Conditionally adds a column using a row+cursor-based function.
- columnIf(String, boolean, RowFunction<T, Object>) - Method in class io.github.dornol.excelkit.excel.ExcelWriter
-
Conditionally adds a column with cursor access using an RowFunction.
- columnIf(String, boolean, RowFunction<T, Object>, Consumer<ExcelColumn.ExcelColumnBuilder<T>>) - Method in class io.github.dornol.excelkit.excel.ExcelWriter
-
Conditionally adds a column with cursor access and additional configuration.
- columnIf(String, boolean, Function<T, Object>) - Method in class io.github.dornol.excelkit.csv.CsvWriter
-
Conditionally adds a column using a basic row-only function.
- columnIf(String, boolean, Function<T, Object>) - Method in class io.github.dornol.excelkit.excel.ExcelSheetWriter
-
Conditionally adds a column using a simple function.
- columnIf(String, boolean, Function<T, Object>) - Method in class io.github.dornol.excelkit.excel.ExcelWriter
-
Conditionally adds a column with default STRING type using a simple Function.
- columnIf(String, boolean, Function<T, Object>, Consumer<ColumnConfig<T>>) - Method in class io.github.dornol.excelkit.excel.ExcelSheetWriter
-
Conditionally adds a column with additional configuration.
- columnIf(String, boolean, Function<T, Object>, Consumer<ExcelColumn.ExcelColumnBuilder<T>>) - Method in class io.github.dornol.excelkit.excel.ExcelWriter
-
Conditionally adds a column with additional configuration.
- columnIndex() - Method in record class io.github.dornol.excelkit.core.CellData
-
Returns the value of the
columnIndexrecord component. - columnIndex() - Method in record class io.github.dornol.excelkit.core.ReadColumn
-
Returns the value of the
columnIndexrecord component. - columnLetter(int) - Static method in class io.github.dornol.excelkit.excel.SheetContext
-
Converts a zero-based column index to an Excel column letter.
- columns(int...) - Method in class io.github.dornol.excelkit.excel.ExcelConditionalRule
-
Sets the columns to apply conditional formatting to (0-based indices).
- ColumnStyleConfig<T,
SELF> - Class in io.github.dornol.excelkit.excel -
Shared base for column styling configuration.
- ColumnStyleConfig() - Constructor for class io.github.dornol.excelkit.excel.ColumnStyleConfig
-
Creates a new column style configuration with defaults.
- ColumnStyleConfig.DefaultStyleConfig<T> - Class in io.github.dornol.excelkit.excel
-
Concrete subclass for defining default column styles at the writer level.
- comment(Function<T, String>) - Method in class io.github.dornol.excelkit.excel.ColumnStyleConfig
-
Sets a function that generates a cell comment (note) for each row.
- commentSize(int, int) - Method in class io.github.dornol.excelkit.excel.ColumnStyleConfig
-
Sets the comment box size (width in cells, height in rows) for this column.
- conditionalFormatting(Consumer<ExcelConditionalRule>) - Method in class io.github.dornol.excelkit.excel.ExcelSheetWriter
-
Adds a conditional formatting rule to the sheet(s).
- conditionalFormatting(Consumer<ExcelConditionalRule>) - Method in class io.github.dornol.excelkit.excel.ExcelWriter
-
Adds a conditional formatting rule.
- configureLargeFileSupport() - Static method in class io.github.dornol.excelkit.excel.ExcelKitConfig
-
Configures Apache POI's internal limits for reading large Excel files.
- configureLargeFileSupport(int, int) - Static method in class io.github.dornol.excelkit.excel.ExcelKitConfig
-
Configures Apache POI's internal limits with custom values.
- constColumn(String, Object) - Method in class io.github.dornol.excelkit.csv.CsvWriter
-
Adds a column with a constant value for all rows.
- constColumn(String, Object) - Method in class io.github.dornol.excelkit.excel.ExcelSheetWriter
-
Adds a column with a constant value for all rows.
- constColumn(String, Object) - Method in class io.github.dornol.excelkit.excel.ExcelWriter
-
Adds a column with a constant value for all rows.
- constColumn(String, Object, Consumer<ExcelColumn.ExcelColumnBuilder<T>>) - Method in class io.github.dornol.excelkit.excel.ExcelWriter
-
Adds a column with a constant value for all rows, with additional configuration.
- constColumnIf(String, boolean, Object) - Method in class io.github.dornol.excelkit.csv.CsvWriter
-
Conditionally adds a column with a constant value for all rows.
- constColumnIf(String, boolean, Object) - Method in class io.github.dornol.excelkit.excel.ExcelWriter
-
Conditionally adds a column with a constant value for all rows.
- CORAL - Static variable in class io.github.dornol.excelkit.excel.ExcelColor
-
Coral (255, 127, 80).
- count(String) - Method in class io.github.dornol.excelkit.excel.ExcelSummary
-
Adds a COUNT formula for the specified column.
- COUNT - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelSummary.Op
-
Count formula.
- create() - Static method in class io.github.dornol.excelkit.csv.CsvWriter
-
Creates a new CSV writer with default settings.
- create() - Static method in class io.github.dornol.excelkit.excel.ExcelWorkbook
-
Creates a new ExcelWorkbook with default initialization (white header, 1000 row window).
- create() - Static method in class io.github.dornol.excelkit.excel.ExcelWriter
-
Creates a new ExcelWriter with default initialization (white header, 1,000,000 max rows, 1000 row window).
- create(Consumer<ExcelWorkbook.InitOptions>) - Static method in class io.github.dornol.excelkit.excel.ExcelWorkbook
-
Creates a new ExcelWorkbook with initialization options.
- create(Consumer<ExcelWriter.InitOptions>) - Static method in class io.github.dornol.excelkit.excel.ExcelWriter
-
Creates a new ExcelWriter with initialization options.
- createTempDirectory() - Static method in class io.github.dornol.excelkit.core.TempResourceCreator
-
Creates a new temporary directory.
- createTempFile(Path, String, String) - Static method in class io.github.dornol.excelkit.core.TempResourceCreator
-
Creates a new temporary file in the specified directory.
- CsvAfterDataWriter - Interface in io.github.dornol.excelkit.csv
-
A functional interface for writing custom content after data rows in CSV output.
- CsvColumn<T> - Class in io.github.dornol.excelkit.csv
-
Represents a single column in a CSV export operation.
- CsvDialect - Enum Class in io.github.dornol.excelkit.csv
-
Predefined CSV dialect configurations for common formats.
- CsvHandler - Class in io.github.dornol.excelkit.csv
-
Handles the output stage of a CSV export.
- csvInjectionDefense(boolean) - Method in class io.github.dornol.excelkit.csv.CsvWriter
-
Enables or disables CSV injection defense.
- CsvQuoting - Enum Class in io.github.dornol.excelkit.csv
-
Quoting strategies for CSV field values.
- csvReader(Function<RowData, T>, Validator) - Method in class io.github.dornol.excelkit.core.ExcelKitSchema
-
Creates a new
CsvReaderin mapping mode for immutable object construction. - csvReader(Supplier<T>, Validator) - Method in class io.github.dornol.excelkit.core.ExcelKitSchema
-
Creates a new
CsvReaderpre-configured with this schema's columns (setter mode). - CsvReader<T> - Class in io.github.dornol.excelkit.csv
-
Builder-style class for configuring CSV row readers.
- CsvReader(Supplier<T>) - Constructor for class io.github.dornol.excelkit.csv.CsvReader
-
Constructs a CsvReader in setter mode without Bean Validation.
- CsvReader(Supplier<T>, Validator) - Constructor for class io.github.dornol.excelkit.csv.CsvReader
-
Constructs a CsvReader in setter mode with instance supplier and optional validator.
- CsvReadException - Exception Class in io.github.dornol.excelkit.csv
-
Exception thrown during CSV read operations.
- CsvReadException(String) - Constructor for exception class io.github.dornol.excelkit.csv.CsvReadException
-
Creates an exception with the given message.
- CsvReadException(String, Throwable) - Constructor for exception class io.github.dornol.excelkit.csv.CsvReadException
-
Creates an exception with the given message and cause.
- CsvReadHandler<T> - Class in io.github.dornol.excelkit.csv
-
Reads CSV files and maps rows to Java objects.
- CsvWriteException - Exception Class in io.github.dornol.excelkit.csv
-
Exception thrown during CSV write operations.
- CsvWriteException(String) - Constructor for exception class io.github.dornol.excelkit.csv.CsvWriteException
-
Creates an exception with the given message.
- CsvWriteException(String, Throwable) - Constructor for exception class io.github.dornol.excelkit.csv.CsvWriteException
-
Creates an exception with the given message and cause.
- csvWriter() - Method in class io.github.dornol.excelkit.core.ExcelKitSchema
-
Creates a new
CsvWriterpre-configured with this schema's columns. - CsvWriter<T> - Class in io.github.dornol.excelkit.csv
-
CSV writer for streaming large datasets into a temporary file.
- CURRENCY_KRW - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelDataFormat
-
Korean currency with "원" suffix (e.g., 1,000원)
- CURRENCY_USD - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelDataFormat
-
US currency with "$" prefix and 2 decimal places (e.g., $1,000.00)
- Cursor - Class in io.github.dornol.excelkit.core
-
Tracks the current writing position during an export operation.
- Cursor() - Constructor for class io.github.dornol.excelkit.core.Cursor
-
Creates a new Cursor with row index and total count initialized to 0.
- Cursor(int) - Constructor for class io.github.dornol.excelkit.core.Cursor
-
Creates a new Cursor starting from a specific row index.
D
- DARK_GRAY - Static variable in class io.github.dornol.excelkit.excel.ExcelColor
-
Dark gray (64, 64, 64).
- DASH_DOT - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelBorderStyle
-
Dash-dot border.
- DASHED - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelBorderStyle
-
Dashed border.
- data() - Method in record class io.github.dornol.excelkit.core.ReadResult
-
Returns the value of the
datarecord component. - data() - Method in record class io.github.dornol.excelkit.excel.ExcelImage
-
Returns the value of the
datarecord component. - dataBar(ExcelColor) - Method in class io.github.dornol.excelkit.excel.ExcelConditionalRule
-
Adds a data bar conditional formatting with the specified fill color.
- dataBar(ExcelColor, ExcelColor) - Method in class io.github.dornol.excelkit.excel.ExcelConditionalRule
-
Adds a 2-color gradient data bar conditional formatting.
- DATE - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelDataFormat
-
Date only format (e.g., 2025-07-19)
- DATE - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelDataType
-
LocalDate formatted as "yyyy-MM-dd".
- DATE - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelValidation.ValidationType
-
Date range validation.
- dateRange(LocalDate, LocalDate) - Static method in class io.github.dornol.excelkit.excel.ExcelValidation
-
Creates a validation that restricts dates between start and end (inclusive).
- DATETIME - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelDataFormat
-
Date-time format (e.g., 2025-07-19 14:23:00)
- DATETIME - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelDataType
-
LocalDateTime formatted as "yyyy-MM-dd HH:mm:ss".
- DECIMAL - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelValidation.ValidationType
-
Decimal value validation.
- decimalBetween(double, double) - Static method in class io.github.dornol.excelkit.excel.ExcelValidation
-
Creates a validation that requires a decimal between min and max (inclusive).
- defaultStyle(Consumer<ColumnStyleConfig.DefaultStyleConfig<T>>) - Method in class io.github.dornol.excelkit.excel.ExcelSheetWriter
-
Sets default column styles that apply to all columns unless overridden per-column.
- defaultStyle(Consumer<ColumnStyleConfig.DefaultStyleConfig<T>>) - Method in class io.github.dornol.excelkit.excel.ExcelWriter
-
Sets default column styles that apply to all columns unless overridden per-column.
- defaultStyle(Consumer<ColumnStyleConfig.DefaultStyleConfig<T>>) - Method in class io.github.dornol.excelkit.excel.TemplateListWriter
-
Sets default column styles that apply to all columns unless overridden per-column.
- DefaultStyleConfig() - Constructor for class io.github.dornol.excelkit.excel.ColumnStyleConfig.DefaultStyleConfig
-
Creates a new default style configuration.
- delimiter(char) - Method in class io.github.dornol.excelkit.csv.CsvReader
-
Sets the delimiter character used to separate fields.
- delimiter(char) - Method in class io.github.dornol.excelkit.csv.CsvWriter
-
Sets the delimiter character used to separate fields.
- dialect(CsvDialect) - Method in class io.github.dornol.excelkit.csv.CsvReader
-
Applies a predefined CSV dialect configuration.
- dialect(CsvDialect) - Method in class io.github.dornol.excelkit.csv.CsvWriter
-
Applies a predefined CSV dialect configuration.
- DOTTED - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelBorderStyle
-
Dotted border.
- DOUBLE - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelBorderStyle
-
Double border.
- DOUBLE - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelDataType
-
Double value with 2 decimal places.
- DOUBLE_PERCENT - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelDataType
-
Double value interpreted as a percentage (e.g.
- DOUGHNUT - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelChartConfig.ChartType
-
Doughnut chart.
- dropdown(String...) - Method in class io.github.dornol.excelkit.excel.ColumnStyleConfig
-
Sets dropdown validation options for this column's cells.
E
- equals(Object) - Method in record class io.github.dornol.excelkit.core.CellData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.dornol.excelkit.core.ExcelKitSchema.SchemaColumn
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.dornol.excelkit.core.ReadColumn
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.dornol.excelkit.core.ReadResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.dornol.excelkit.excel.ExcelCellComment
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.dornol.excelkit.excel.ExcelHyperlink
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.dornol.excelkit.excel.ExcelImage
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.dornol.excelkit.excel.ExcelSheetInfo
-
Indicates whether some other object is "equal to" this one.
- equalTo(String, ExcelColor) - Method in class io.github.dornol.excelkit.excel.ExcelConditionalRule
-
Adds a rule: cell value equal to the given value.
- errorMessage(String) - Method in class io.github.dornol.excelkit.excel.ExcelValidation
-
Sets the error dialog message.
- errorTitle(String) - Method in class io.github.dornol.excelkit.excel.ExcelValidation
-
Sets the error dialog title.
- EXCEL - Enum constant in enum class io.github.dornol.excelkit.csv.CsvDialect
-
Excel-compatible: comma delimiter, UTF-8 with BOM for proper Korean/CJK display.
- ExcelBorderStyle - Enum Class in io.github.dornol.excelkit.excel
-
Predefined border styles for Excel cells.
- ExcelCellComment - Record Class in io.github.dornol.excelkit.excel
-
Represents a cell comment (note) to be added to an Excel cell.
- ExcelCellComment(String, String, int, int) - Constructor for record class io.github.dornol.excelkit.excel.ExcelCellComment
-
Validates invariants.
- ExcelChartConfig - Class in io.github.dornol.excelkit.excel
-
Builder for creating charts in an Excel sheet.
- ExcelChartConfig() - Constructor for class io.github.dornol.excelkit.excel.ExcelChartConfig
-
Creates a new chart configuration with defaults.
- ExcelChartConfig.BarDirection - Enum Class in io.github.dornol.excelkit.excel
-
Bar chart direction.
- ExcelChartConfig.BarGrouping - Enum Class in io.github.dornol.excelkit.excel
-
Bar chart grouping mode.
- ExcelChartConfig.ChartType - Enum Class in io.github.dornol.excelkit.excel
-
Supported chart types.
- ExcelChartConfig.LegendPosition - Enum Class in io.github.dornol.excelkit.excel
-
Legend position relative to the chart area.
- ExcelColor - Class in io.github.dornol.excelkit.excel
-
Represents an RGB color for Excel header backgrounds and cell styling.
- ExcelColumn<T> - Class in io.github.dornol.excelkit.excel
-
Represents a single Excel column and how its value is derived, styled, and rendered.
- ExcelColumn.ExcelColumnBuilder<T> - Class in io.github.dornol.excelkit.excel
-
Builder for constructing
ExcelColumninstances using a fluent DSL-style API. - ExcelConditionalRule - Class in io.github.dornol.excelkit.excel
-
Builder for conditional formatting rules to apply to Excel sheets.
- ExcelConditionalRule() - Constructor for class io.github.dornol.excelkit.excel.ExcelConditionalRule
-
Creates a new conditional rule builder.
- ExcelConditionalRule.IconSetType - Enum Class in io.github.dornol.excelkit.excel
-
Supported icon set types for conditional formatting.
- ExcelDataFormat - Enum Class in io.github.dornol.excelkit.excel
-
Predefined Excel-compatible data format strings used for number, date, time, and currency formatting.
- ExcelDataType - Enum Class in io.github.dornol.excelkit.excel
-
Enum representing supported Excel cell data types.
- ExcelHandler - Class in io.github.dornol.excelkit.excel
-
Handles the final output stage of an Excel export.
- ExcelHyperlink - Record Class in io.github.dornol.excelkit.excel
-
Represents a hyperlink value for Excel cells.
- ExcelHyperlink(String) - Constructor for record class io.github.dornol.excelkit.excel.ExcelHyperlink
-
Creates a hyperlink where the URL is also used as the display label.
- ExcelHyperlink(String, String) - Constructor for record class io.github.dornol.excelkit.excel.ExcelHyperlink
-
Creates an instance of a
ExcelHyperlinkrecord class. - ExcelImage - Record Class in io.github.dornol.excelkit.excel
-
Represents image data to be embedded in an Excel cell.
- ExcelImage(byte[], int) - Constructor for record class io.github.dornol.excelkit.excel.ExcelImage
-
Validates that image data is not null or empty.
- ExcelKitConfig - Class in io.github.dornol.excelkit.excel
-
Application-level configuration for excel-kit.
- ExcelKitException - Exception Class in io.github.dornol.excelkit.core
-
Base exception for all excel-kit library errors.
- ExcelKitException(String) - Constructor for exception class io.github.dornol.excelkit.core.ExcelKitException
-
Creates an exception with the given message.
- ExcelKitException(String, Throwable) - Constructor for exception class io.github.dornol.excelkit.core.ExcelKitException
-
Creates an exception with the given message and cause.
- ExcelKitException(Throwable) - Constructor for exception class io.github.dornol.excelkit.core.ExcelKitException
-
Creates an exception with the given cause.
- ExcelKitSchema<T> - Class in io.github.dornol.excelkit.core
-
Unified schema that defines read/write column mappings for a single entity type.
- ExcelKitSchema.Builder<T> - Class in io.github.dornol.excelkit.core
-
Builder for constructing
ExcelKitSchemainstances. - ExcelKitSchema.SchemaColumn<T> - Record Class in io.github.dornol.excelkit.core
-
Represents a single column definition in the schema.
- ExcelPrintSetup - Class in io.github.dornol.excelkit.excel
-
Configures page layout settings for printing Excel sheets.
- ExcelPrintSetup() - Constructor for class io.github.dornol.excelkit.excel.ExcelPrintSetup
-
Creates a new print setup configuration with defaults.
- ExcelPrintSetup.Orientation - Enum Class in io.github.dornol.excelkit.excel
-
Page orientation for printing.
- ExcelPrintSetup.PaperSize - Enum Class in io.github.dornol.excelkit.excel
-
Standard paper sizes for printing.
- excelReader(Function<RowData, T>, Validator) - Method in class io.github.dornol.excelkit.core.ExcelKitSchema
-
Creates a new
ExcelReaderin mapping mode for immutable object construction. - excelReader(Supplier<T>, Validator) - Method in class io.github.dornol.excelkit.core.ExcelKitSchema
-
Creates a new
ExcelReaderpre-configured with this schema's columns (setter mode). - ExcelReader<T> - Class in io.github.dornol.excelkit.excel
-
Builder-style class for configuring Excel row readers.
- ExcelReader(Supplier<T>) - Constructor for class io.github.dornol.excelkit.excel.ExcelReader
-
Constructs an ExcelReader in setter mode without Bean Validation.
- ExcelReader(Supplier<T>, Validator) - Constructor for class io.github.dornol.excelkit.excel.ExcelReader
-
Constructs an ExcelReader in setter mode with instance supplier and optional validator.
- ExcelReadException - Exception Class in io.github.dornol.excelkit.excel
-
Exception thrown during Excel read operations.
- ExcelReadException(String) - Constructor for exception class io.github.dornol.excelkit.excel.ExcelReadException
-
Creates an exception with the given message.
- ExcelReadException(String, Throwable) - Constructor for exception class io.github.dornol.excelkit.excel.ExcelReadException
-
Creates an exception with the given message and cause.
- ExcelReadHandler<T> - Class in io.github.dornol.excelkit.excel
-
Reads Excel (.xlsx) files using Apache POI's event-based streaming API.
- ExcelRichText - Class in io.github.dornol.excelkit.excel
-
Fluent builder for creating rich text content with mixed formatting within a single Excel cell.
- ExcelRichText() - Constructor for class io.github.dornol.excelkit.excel.ExcelRichText
-
Creates a new empty rich text instance.
- ExcelRichText.FontStyle - Class in io.github.dornol.excelkit.excel
-
Style configuration for a rich text segment.
- ExcelSheetInfo - Record Class in io.github.dornol.excelkit.excel
-
Holds metadata about a sheet in an Excel file.
- ExcelSheetInfo(int, String) - Constructor for record class io.github.dornol.excelkit.excel.ExcelSheetInfo
-
Creates an instance of a
ExcelSheetInforecord class. - ExcelSheetWriter<T> - Class in io.github.dornol.excelkit.excel
-
Writes data of a specific type to one or more sheets within an
ExcelWorkbook. - ExcelSummary - Class in io.github.dornol.excelkit.excel
-
Fluent DSL for adding summary (footer) rows with formulas such as SUM, AVERAGE, COUNT, MIN, MAX.
- ExcelSummary() - Constructor for class io.github.dornol.excelkit.excel.ExcelSummary
-
Creates a new summary configuration.
- ExcelSummary.Op - Enum Class in io.github.dornol.excelkit.excel
-
Supported summary operations.
- ExcelTemplateWriter - Class in io.github.dornol.excelkit.excel
-
Fills data into an existing Excel template (.xlsx) while preserving formatting, images, charts, and merged regions.
- ExcelTemplateWriter(InputStream) - Constructor for class io.github.dornol.excelkit.excel.ExcelTemplateWriter
-
Opens a template from the given input stream.
- ExcelTemplateWriter(InputStream, int) - Constructor for class io.github.dornol.excelkit.excel.ExcelTemplateWriter
-
Opens a template from the given input stream with a custom row access window size.
- ExcelValidation - Class in io.github.dornol.excelkit.excel
-
Advanced data validation configuration for Excel columns.
- ExcelValidation.ValidationType - Enum Class in io.github.dornol.excelkit.excel
-
Supported validation types.
- ExcelWorkbook - Class in io.github.dornol.excelkit.excel
-
Orchestrates multi-sheet Excel workbook creation where each sheet can have a different data type.
- ExcelWorkbook.InitOptions - Class in io.github.dornol.excelkit.excel
-
Initialization options for
ExcelWorkbook. - ExcelWriteException - Exception Class in io.github.dornol.excelkit.excel
-
Exception thrown during Excel write operations.
- ExcelWriteException(String) - Constructor for exception class io.github.dornol.excelkit.excel.ExcelWriteException
-
Creates an exception with the given message.
- ExcelWriteException(String, Throwable) - Constructor for exception class io.github.dornol.excelkit.excel.ExcelWriteException
-
Creates an exception with the given message and cause.
- excelWriter() - Method in class io.github.dornol.excelkit.core.ExcelKitSchema
-
Creates a new
ExcelWriterpre-configured with this schema's columns. - ExcelWriter<T> - Class in io.github.dornol.excelkit.excel
-
ExcelWriter is a utility class for generating large Excel files using Apache POI's SXSSFWorkbook.
- ExcelWriter.InitOptions - Class in io.github.dornol.excelkit.excel
-
Initialization options for
ExcelWriter.
F
- FileHandler - Interface in io.github.dornol.excelkit.core
-
Common contract for file handlers produced by writer entry points.
- finish() - Method in class io.github.dornol.excelkit.excel.ExcelTemplateWriter
-
Finishes the template and returns an
ExcelHandlerfor output. - finish() - Method in class io.github.dornol.excelkit.excel.ExcelWorkbook
-
Finishes the workbook and returns an
ExcelHandlerfor output. - fitToPage(int, int) - Method in class io.github.dornol.excelkit.excel.ExcelPrintSetup
-
Enables fit-to-page scaling with the specified width and height in pages.
- fitToPageWidth() - Method in class io.github.dornol.excelkit.excel.ExcelPrintSetup
-
Fits the sheet to one page wide with automatic height.
- FLAGS_3 - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelConditionalRule.IconSetType
-
3 flags icon set.
- FLOAT - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelDataType
-
Float value with 2 decimal places.
- FLOAT_PERCENT - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelDataType
-
Float value interpreted as a percentage.
- fontColor(int, int, int) - Method in class io.github.dornol.excelkit.excel.ColumnStyleConfig
-
Sets the font color for this column's cells using RGB values.
- fontColor(ExcelColor) - Method in class io.github.dornol.excelkit.excel.ColumnStyleConfig
-
Sets the font color for this column's cells using a preset color.
- fontName(String) - Method in class io.github.dornol.excelkit.excel.ColumnStyleConfig
-
Sets the font family name for this column's cells.
- fontSize(int) - Method in class io.github.dornol.excelkit.excel.ColumnStyleConfig
-
Sets the font size for this column's cells.
- fontSize(int) - Method in class io.github.dornol.excelkit.excel.ExcelRichText.FontStyle
-
Sets the font size in points.
- FontStyle() - Constructor for class io.github.dornol.excelkit.excel.ExcelRichText.FontStyle
-
Creates a new font style with defaults.
- footerCenter(String) - Method in class io.github.dornol.excelkit.excel.ExcelPrintSetup
-
Sets the center section of the page footer.
- footerLeft(String) - Method in class io.github.dornol.excelkit.excel.ExcelPrintSetup
-
Sets the left section of the page footer.
- footerRight(String) - Method in class io.github.dornol.excelkit.excel.ExcelPrintSetup
-
Sets the right section of the page footer.
- FOREST_GREEN - Static variable in class io.github.dornol.excelkit.excel.ExcelColor
-
Forest green (34, 139, 34).
- forMap() - Static method in class io.github.dornol.excelkit.csv.CsvReader
-
Creates a reader that parses CSV files into
Map<String, String>rows by auto-discovering columns from the header row. - forMap() - Static method in class io.github.dornol.excelkit.excel.ExcelReader
-
Creates a reader that parses Excel files into
Map<String, String>rows by auto-discovering columns from the header row. - forMap(String...) - Static method in class io.github.dornol.excelkit.csv.CsvReader
-
Creates a reader that parses CSV files into
Map<String, String>rows, including only the specified columns. - forMap(String...) - Static method in class io.github.dornol.excelkit.csv.CsvWriter
-
Creates a CsvWriter pre-configured to write rows of
Map<String, Object>, with one column per given column name. - forMap(String...) - Static method in class io.github.dornol.excelkit.excel.ExcelReader
-
Creates a reader that parses Excel files into
Map<String, String>rows, including only the specified columns. - forMap(String...) - Static method in class io.github.dornol.excelkit.excel.ExcelWriter
-
Creates an ExcelWriter pre-configured to write rows of
Map<String, Object>, with one column per given column name. - forMap(String[], Consumer<ExcelColumn.ExcelColumnBuilder<Map<String, Object>>>...) - Static method in class io.github.dornol.excelkit.excel.ExcelWriter
-
Creates an ExcelWriter pre-configured for
Map<String, Object>rows, with per-column configurers that can adjust type, format, styling, etc. - forMap(Consumer<ExcelWriter.InitOptions>, String...) - Static method in class io.github.dornol.excelkit.excel.ExcelWriter
-
Creates a map-valued ExcelWriter with initialization options (currently only
rowAccessWindowSize). - format(String) - Method in class io.github.dornol.excelkit.excel.ColumnStyleConfig
-
Sets the column's Excel cell data format.
- formattedValue() - Method in record class io.github.dornol.excelkit.core.CellData
-
Returns the value of the
formattedValuerecord component. - formula(String) - Static method in class io.github.dornol.excelkit.excel.ExcelValidation
-
Creates a validation using a custom Excel formula.
- FORMULA - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelDataType
-
Formula type.
- FORMULA - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelValidation.ValidationType
-
Custom formula validation.
- freezeCols(int) - Method in class io.github.dornol.excelkit.excel.ExcelSheetWriter
-
Freezes the specified number of left columns.
- freezeCols(int) - Method in class io.github.dornol.excelkit.excel.ExcelWriter
-
Freezes the given number of columns from the left edge.
- freezePane(int, int) - Method in class io.github.dornol.excelkit.excel.ExcelSheetWriter
-
Freezes the specified number of columns and rows.
- freezePane(int, int) - Method in class io.github.dornol.excelkit.excel.ExcelWriter
-
Sets the number of columns and rows to freeze.
- freezeRows(int) - Method in class io.github.dornol.excelkit.excel.ExcelSheetWriter
-
Freezes the specified number of top rows.
- freezeRows(int) - Method in class io.github.dornol.excelkit.excel.ExcelWriter
-
Freezes the given number of rows below the header row.
G
- get(int) - Method in class io.github.dornol.excelkit.core.RowData
-
Gets cell data by column index (0-based).
- get(String) - Method in class io.github.dornol.excelkit.core.RowData
-
Gets cell data by header name.
- getB() - Method in class io.github.dornol.excelkit.excel.ExcelColor
-
Returns the blue component (0-255).
- getCharset() - Method in enum class io.github.dornol.excelkit.csv.CsvDialect
-
Returns the character encoding.
- getColumnCount() - Method in class io.github.dornol.excelkit.excel.SheetContext
-
Returns the number of columns configured for this sheet.
- getColumnNames() - Method in class io.github.dornol.excelkit.excel.SheetContext
-
Returns an unmodifiable list of column header names, in order.
- getColumns() - Method in class io.github.dornol.excelkit.core.ExcelKitSchema
-
Returns the unmodifiable list of schema columns.
- getCurrentRow() - Method in class io.github.dornol.excelkit.excel.SheetContext
-
Returns the current row index available for writing.
- getCurrentTotal() - Method in class io.github.dornol.excelkit.core.Cursor
-
Returns the total number of processed rows, across all sheets.
- getDateFormats() - Static method in record class io.github.dornol.excelkit.core.CellData
-
Returns an unmodifiable view of the currently registered date format patterns.
- getDateTimeFormats() - Static method in record class io.github.dornol.excelkit.core.CellData
-
Returns an unmodifiable view of the currently registered date-time format patterns.
- getDefaultLocale() - Static method in record class io.github.dornol.excelkit.core.CellData
-
Returns the default locale used by no-arg number parsing methods.
- getDelimiter() - Method in enum class io.github.dornol.excelkit.csv.CsvDialect
-
Returns the field delimiter character.
- getFormat() - Method in enum class io.github.dornol.excelkit.excel.ExcelDataFormat
-
Returns the Excel-compatible format string.
- getG() - Method in class io.github.dornol.excelkit.excel.ExcelColor
-
Returns the green component (0-255).
- getHeaderRowIndex() - Method in class io.github.dornol.excelkit.excel.SheetContext
-
Returns the header row index (zero-based) for this sheet.
- getR() - Method in class io.github.dornol.excelkit.excel.ExcelColor
-
Returns the red component (0-255).
- getRowOfSheet() - Method in class io.github.dornol.excelkit.core.Cursor
-
Returns the current row index within the sheet.
- getSheet() - Method in class io.github.dornol.excelkit.excel.SheetContext
-
Returns the current sheet being written to.
- getSheetHeaders(InputStream, int, int) - Static method in class io.github.dornol.excelkit.excel.ExcelReader
-
Returns the header names from a specific sheet.
- getSheetNames(InputStream) - Static method in class io.github.dornol.excelkit.excel.ExcelReader
-
Returns the list of sheet names and indices from an Excel file.
- getTempDir() - Method in class io.github.dornol.excelkit.core.TempResourceContainer
-
Returns the path to the temporary directory (if set).
- getTempFile() - Method in class io.github.dornol.excelkit.core.TempResourceContainer
-
Returns the path to the temporary file (if set).
- getWorkbook() - Method in class io.github.dornol.excelkit.excel.SheetContext
-
Returns the workbook (useful for creating CellStyles, etc.).
- GOLD - Static variable in class io.github.dornol.excelkit.excel.ExcelColor
-
Gold (255, 215, 0).
- GRAY - Static variable in class io.github.dornol.excelkit.excel.ExcelColor
-
Gray (128, 128, 128).
- greaterThan(String, ExcelColor) - Method in class io.github.dornol.excelkit.excel.ExcelConditionalRule
-
Adds a rule: cell value greater than the given value.
- greaterThanOrEqual(String, ExcelColor) - Method in class io.github.dornol.excelkit.excel.ExcelConditionalRule
-
Adds a rule: cell value greater than or equal to the given value.
- GREEN - Static variable in class io.github.dornol.excelkit.excel.ExcelColor
-
Green (0, 128, 0).
- group(String) - Method in class io.github.dornol.excelkit.excel.ColumnStyleConfig
-
Sets the group header name for this column.
- groupRows(int, int) - Method in class io.github.dornol.excelkit.excel.SheetContext
-
Groups (outlines) a range of rows so they can be collapsed/expanded in Excel.
- groupRows(int, int, boolean) - Method in class io.github.dornol.excelkit.excel.SheetContext
-
Groups (outlines) a range of rows, optionally collapsing them.
H
- HAIR - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelBorderStyle
-
Hairline border.
- has(String) - Method in class io.github.dornol.excelkit.core.RowData
-
Checks whether a header name exists in this row's header definition.
- hashCode() - Method in record class io.github.dornol.excelkit.core.CellData
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.dornol.excelkit.core.ExcelKitSchema.SchemaColumn
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.dornol.excelkit.core.ReadColumn
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.dornol.excelkit.core.ReadResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.dornol.excelkit.excel.ExcelCellComment
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.dornol.excelkit.excel.ExcelHyperlink
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.dornol.excelkit.excel.ExcelImage
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.dornol.excelkit.excel.ExcelSheetInfo
-
Returns a hash code value for this object.
- Header/Footer special codes - Search tag in class io.github.dornol.excelkit.excel.ExcelPrintSetup
- Section
- headerCenter(String) - Method in class io.github.dornol.excelkit.excel.ExcelPrintSetup
-
Sets the center section of the page header.
- headerColor(ExcelColor) - Method in class io.github.dornol.excelkit.excel.ExcelWorkbook
-
Sets the header background color for all sheets.
- headerColor(ExcelColor) - Method in class io.github.dornol.excelkit.excel.ExcelWriter
-
Sets the header background color.
- headerComment(ExcelCellComment) - Method in class io.github.dornol.excelkit.excel.ColumnStyleConfig
-
Sets a static comment (note) on this column's header cell with full customization (author, size).
- headerComment(String) - Method in class io.github.dornol.excelkit.excel.ColumnStyleConfig
-
Sets a static comment (note) on this column's header cell.
- headerFontColor(int, int, int) - Method in class io.github.dornol.excelkit.excel.ColumnStyleConfig
-
Sets the font color for this column's header cell using RGB values.
- headerFontColor(ExcelColor) - Method in class io.github.dornol.excelkit.excel.ColumnStyleConfig
-
Sets the font color for this column's header cell using a preset color.
- headerFontName(String) - Method in class io.github.dornol.excelkit.excel.ExcelWorkbook
-
Sets the header font name for all sheets.
- headerFontName(String) - Method in class io.github.dornol.excelkit.excel.ExcelWriter
-
Sets the header font name.
- headerFontSize(int) - Method in class io.github.dornol.excelkit.excel.ExcelWorkbook
-
Sets the header font size for all sheets.
- headerFontSize(int) - Method in class io.github.dornol.excelkit.excel.ExcelWriter
-
Sets the header font size in points.
- headerLeft(String) - Method in class io.github.dornol.excelkit.excel.ExcelPrintSetup
-
Sets the left section of the page header.
- headerName() - Method in record class io.github.dornol.excelkit.core.ReadColumn
-
Returns the value of the
headerNamerecord component. - headerNames() - Method in class io.github.dornol.excelkit.core.RowData
-
Returns the header names from the file.
- headerRight(String) - Method in class io.github.dornol.excelkit.excel.ExcelPrintSetup
-
Sets the right section of the page header.
- headerRowIndex(int) - Method in class io.github.dornol.excelkit.csv.CsvReader
-
Sets the zero-based row index of the header row.
- headerRowIndex(int) - Method in class io.github.dornol.excelkit.excel.ExcelReader
-
Sets the zero-based row index of the header row.
- height() - Method in record class io.github.dornol.excelkit.excel.ExcelCellComment
-
Returns the value of the
heightrecord component. - hidden() - Method in class io.github.dornol.excelkit.excel.ColumnStyleConfig
-
Marks this column as hidden in the Excel output.
- hidden(boolean) - Method in class io.github.dornol.excelkit.excel.ColumnStyleConfig
-
Sets whether this column should be hidden in the Excel output.
- HORIZONTAL - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelChartConfig.BarDirection
-
Bars are drawn as horizontal bars.
- HYPERLINK - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelDataType
-
Hyperlink type.
I
- iconSet(ExcelConditionalRule.IconSetType) - Method in class io.github.dornol.excelkit.excel.ExcelConditionalRule
-
Adds an icon set conditional formatting.
- IMAGE - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelDataType
-
Image type.
- imageType() - Method in record class io.github.dornol.excelkit.excel.ExcelImage
-
Returns the value of the
imageTyperecord component. - indentation(int) - Method in class io.github.dornol.excelkit.excel.ColumnStyleConfig
-
Sets the indentation level for this column's cells.
- index() - Method in record class io.github.dornol.excelkit.excel.ExcelSheetInfo
-
Returns the value of the
indexrecord component. - initRow() - Method in class io.github.dornol.excelkit.core.Cursor
-
Resets the current sheet's row index to the base row.
- instanceSupplier - Variable in class io.github.dornol.excelkit.core.AbstractReadHandler
-
Supplier for creating new row instances (setter mode).
- INTEGER - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelDataType
-
Integer value.
- INTEGER - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelValidation.ValidationType
-
Integer value validation.
- integerBetween(int, int) - Static method in class io.github.dornol.excelkit.excel.ExcelValidation
-
Creates a validation that requires an integer between min and max (inclusive).
- integerGreaterThan(int) - Static method in class io.github.dornol.excelkit.excel.ExcelValidation
-
Creates a validation that requires an integer greater than the given value.
- integerLessThan(int) - Static method in class io.github.dornol.excelkit.excel.ExcelValidation
-
Creates a validation that requires an integer less than the given value.
- io.github.dornol.excelkit.core - package io.github.dornol.excelkit.core
-
Shared infrastructure for Excel and CSV processing:
FileHandleroutput interface,ReadColumnbinding,CellDatavalue access,RowDatafor mapping mode, temp file management, and progress callbacks. - io.github.dornol.excelkit.csv - package io.github.dornol.excelkit.csv
-
Streaming CSV export and OpenCSV-based import with dialect presets, quoting strategies, BOM handling, CSV injection defense, and map-mode reading.
- io.github.dornol.excelkit.excel - package io.github.dornol.excelkit.excel
-
Streaming Excel (.xlsx) export and SAX-based import via Apache POI SXSSFWorkbook.
- isBom() - Method in enum class io.github.dornol.excelkit.csv.CsvDialect
-
Returns whether a UTF-8 BOM should be written.
- isEmpty() - Method in record class io.github.dornol.excelkit.core.CellData
-
Checks if the value is empty or blank.
- isRequired() - Method in record class io.github.dornol.excelkit.core.ReadColumn
-
Returns the value of the
isRequiredrecord component. - italic(boolean) - Method in class io.github.dornol.excelkit.excel.ExcelRichText.FontStyle
-
Sets italic styling.
- italic(String) - Method in class io.github.dornol.excelkit.excel.ExcelRichText
-
Appends italic text.
J
- jpeg(byte[]) - Static method in record class io.github.dornol.excelkit.excel.ExcelImage
-
Creates a JPEG image.
L
- label() - Method in record class io.github.dornol.excelkit.excel.ExcelHyperlink
-
Returns the value of the
labelrecord component. - label(String) - Method in class io.github.dornol.excelkit.excel.ExcelSummary
-
Sets the label text for the summary row(s).
- label(String, String) - Method in class io.github.dornol.excelkit.excel.ExcelSummary
-
Sets the label text for the summary row(s) in a specific column.
- LANDSCAPE - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelPrintSetup.Orientation
-
Landscape orientation (wider than tall).
- Large file tuning - Search tag in class io.github.dornol.excelkit.excel.ExcelReadHandler
- Section
- LEFT - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelChartConfig.LegendPosition
-
Left position.
- leftMargin(double) - Method in class io.github.dornol.excelkit.excel.ExcelPrintSetup
-
Sets the left margin.
- LEGAL - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelPrintSetup.PaperSize
-
US Legal size.
- legendPosition(ExcelChartConfig.LegendPosition) - Method in class io.github.dornol.excelkit.excel.ExcelChartConfig
-
Sets the legend position.
- lessThan(String, ExcelColor) - Method in class io.github.dornol.excelkit.excel.ExcelConditionalRule
-
Adds a rule: cell value less than the given value.
- lessThanOrEqual(String, ExcelColor) - Method in class io.github.dornol.excelkit.excel.ExcelConditionalRule
-
Adds a rule: cell value less than or equal to the given value.
- LETTER - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelPrintSetup.PaperSize
-
US Letter size.
- LIGHT_BLUE - Static variable in class io.github.dornol.excelkit.excel.ExcelColor
-
Light blue for backgrounds.
- LIGHT_GRAY - Static variable in class io.github.dornol.excelkit.excel.ExcelColor
-
Light gray (217, 217, 217).
- LIGHT_GREEN - Static variable in class io.github.dornol.excelkit.excel.ExcelColor
-
Light green for backgrounds.
- LIGHT_ORANGE - Static variable in class io.github.dornol.excelkit.excel.ExcelColor
-
Light orange for backgrounds.
- LIGHT_PURPLE - Static variable in class io.github.dornol.excelkit.excel.ExcelColor
-
Light purple for backgrounds.
- LIGHT_RED - Static variable in class io.github.dornol.excelkit.excel.ExcelColor
-
Light red for backgrounds.
- LIGHT_YELLOW - Static variable in class io.github.dornol.excelkit.excel.ExcelColor
-
Light yellow for backgrounds.
- LINE - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelChartConfig.ChartType
-
Line chart.
- list(int) - Method in class io.github.dornol.excelkit.excel.ExcelTemplateWriter
-
Creates a list writer for streaming tabular data starting at the given row on the active sheet.
- list(int, int) - Method in class io.github.dornol.excelkit.excel.ExcelTemplateWriter
-
Creates a list writer for streaming tabular data into a specific sheet.
- LIST_FORMULA - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelValidation.ValidationType
-
List from cell range validation.
- listFromRange(String) - Static method in class io.github.dornol.excelkit.excel.ExcelValidation
-
Creates a list validation that references a cell range for dropdown options.
- locked(boolean) - Method in class io.github.dornol.excelkit.excel.ColumnStyleConfig
-
Sets whether this column's cells should be locked when sheet protection is enabled.
- LONG - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelDataType
-
Long integer value.
M
- mapColumn(ReadColumn<T>, T, CellData, int, List<String>, List<String>) - Method in class io.github.dornol.excelkit.core.AbstractReadHandler
-
Maps a single column value to the instance, with required-field validation.
- mapColumn(BiConsumer<T, CellData>, T, CellData, int, List<String>, List<String>) - Method in class io.github.dornol.excelkit.core.AbstractReadHandler
-
Maps a single column value to the instance, handling exceptions.
- mapping(Function<RowData, T>) - Static method in class io.github.dornol.excelkit.csv.CsvReader
-
Creates a CsvReader in mapping mode for immutable object construction.
- mapping(Function<RowData, T>) - Static method in class io.github.dornol.excelkit.excel.ExcelReader
-
Creates an ExcelReader in mapping mode for immutable object construction.
- mapping(Function<RowData, T>, Validator) - Static method in class io.github.dornol.excelkit.csv.CsvReader
-
Creates a CsvReader in mapping mode with Bean Validation support.
- mapping(Function<RowData, T>, Validator) - Static method in class io.github.dornol.excelkit.excel.ExcelReader
-
Creates an ExcelReader in mapping mode with Bean Validation support.
- mapWithRowMapper(RowData) - Method in class io.github.dornol.excelkit.core.AbstractReadHandler
-
Maps a row using the row mapper function (mapping mode).
- margins(double, double, double, double) - Method in class io.github.dornol.excelkit.excel.ExcelPrintSetup
-
Sets all four page margins at once.
- max(String) - Method in class io.github.dornol.excelkit.excel.ExcelSummary
-
Adds a MAX formula for the specified column.
- MAX - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelSummary.Op
-
Max formula.
- maxRows(int) - Method in class io.github.dornol.excelkit.excel.ExcelSheetWriter
-
Sets the maximum number of rows per sheet before auto-rollover.
- maxRows(int) - Method in class io.github.dornol.excelkit.excel.ExcelWriter
-
Sets the maximum number of rows per sheet before a new sheet is created.
- maxWidth(int) - Method in class io.github.dornol.excelkit.excel.ColumnStyleConfig
-
Sets the maximum column width.
- MEDIUM - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelBorderStyle
-
Medium border.
- MEDIUM_DASHED - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelBorderStyle
-
Medium dashed border.
- mergeCells(int, int, int, int) - Method in class io.github.dornol.excelkit.excel.SheetContext
-
Merges a rectangular region of cells identified by zero-based row and column indices.
- mergeCells(String) - Method in class io.github.dornol.excelkit.excel.SheetContext
-
Merges a rectangular region of cells identified by an Excel-style range string such as
"A1:C3". - messages() - Method in record class io.github.dornol.excelkit.core.ReadResult
-
Returns the value of the
messagesrecord component. - min(String) - Method in class io.github.dornol.excelkit.excel.ExcelSummary
-
Adds a MIN formula for the specified column.
- MIN - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelSummary.Op
-
Min formula.
- MINIMAL - Enum constant in enum class io.github.dornol.excelkit.csv.CsvQuoting
-
Quote only when necessary — when the value contains the delimiter, quotes, or newlines.
- minWidth(int) - Method in class io.github.dornol.excelkit.excel.ColumnStyleConfig
-
Sets the minimum column width.
N
- name() - Method in record class io.github.dornol.excelkit.core.ExcelKitSchema.SchemaColumn
-
Returns the value of the
namerecord component. - name() - Method in record class io.github.dornol.excelkit.excel.ExcelSheetInfo
-
Returns the value of the
namerecord component. - namedRange(String, int, int, int) - Method in class io.github.dornol.excelkit.excel.SheetContext
-
Creates a workbook-scoped named range for a column range on the current sheet.
- namedRange(String, String) - Method in class io.github.dornol.excelkit.excel.SheetContext
-
Creates a workbook-scoped named range with the given reference formula.
- NAVY - Static variable in class io.github.dornol.excelkit.excel.ExcelColor
-
Navy (0, 0, 128).
- NON_NUMERIC - Enum constant in enum class io.github.dornol.excelkit.csv.CsvQuoting
-
Quote fields that are not purely numeric.
- NONE - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelBorderStyle
-
No border.
- notBetween(String, String, ExcelColor) - Method in class io.github.dornol.excelkit.excel.ExcelConditionalRule
-
Adds a rule: cell value not between the given values.
- notEqualTo(String, ExcelColor) - Method in class io.github.dornol.excelkit.excel.ExcelConditionalRule
-
Adds a rule: cell value not equal to the given value.
- nullValue(Object) - Method in class io.github.dornol.excelkit.excel.ColumnStyleConfig
-
Sets the default value to write when the column function returns
null. - NUMBER - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelDataFormat
-
Number with thousand separator and no decimals (e.g., 1,000)
- NUMBER_1 - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelDataFormat
-
Number with 1 decimal place (e.g., 1,000.1)
- NUMBER_2 - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelDataFormat
-
Number with 2 decimal places (e.g., 1,000.12)
- NUMBER_4 - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelDataFormat
-
Number with 4 decimal places (e.g., 1,000.1234)
O
- of(int, int, int) - Static method in class io.github.dornol.excelkit.excel.ExcelColor
-
Creates a custom color from RGB values.
- of(String) - Static method in record class io.github.dornol.excelkit.excel.ExcelCellComment
-
Creates a comment with the given text, no author, and default size.
- One-shot contract - Search tag in interface io.github.dornol.excelkit.core.FileHandler
- Section
- onProgress(int, ProgressCallback) - Method in class io.github.dornol.excelkit.csv.CsvReader
-
Registers a progress callback that fires every
intervalrows during reading. - onProgress(int, ProgressCallback) - Method in class io.github.dornol.excelkit.csv.CsvWriter
-
Registers a progress callback that fires every
intervalrows. - onProgress(int, ProgressCallback) - Method in class io.github.dornol.excelkit.excel.ExcelReader
-
Registers a progress callback that fires every
intervalrows during reading. - onProgress(int, ProgressCallback) - Method in class io.github.dornol.excelkit.excel.ExcelSheetWriter
-
Registers a progress callback that fires every
intervalrows. - onProgress(int, ProgressCallback) - Method in class io.github.dornol.excelkit.excel.ExcelWriter
-
Registers a progress callback that fires every
intervalrows. - onProgress(int, ProgressCallback) - Method in class io.github.dornol.excelkit.excel.TemplateListWriter
-
Registers a progress callback that fires every
intervalrows. - onProgress(long, Cursor) - Method in interface io.github.dornol.excelkit.core.ProgressCallback
-
Called when the specified number of rows have been processed.
- ORANGE - Static variable in class io.github.dornol.excelkit.excel.ExcelColor
-
Orange (255, 165, 0).
- orientation(ExcelPrintSetup.Orientation) - Method in class io.github.dornol.excelkit.excel.ExcelPrintSetup
-
Sets the page orientation.
- outline(int) - Method in class io.github.dornol.excelkit.excel.ColumnStyleConfig
-
Sets the outline (grouping) level for this column.
P
- paperSize(ExcelPrintSetup.PaperSize) - Method in class io.github.dornol.excelkit.excel.ExcelPrintSetup
-
Sets the paper size.
- password(String) - Method in class io.github.dornol.excelkit.excel.ExcelReader
-
Sets the password for reading encrypted Excel files.
- password(String) - Method in class io.github.dornol.excelkit.excel.ExcelWorkbook
-
Sets the file encryption password.
- password(String) - Method in class io.github.dornol.excelkit.excel.ExcelWriter
-
Sets the file encryption password.
- PERCENT - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelDataFormat
-
Percent format with 2 decimal places (e.g., 12.34%)
- PERCENT_STACKED - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelChartConfig.BarGrouping
-
Series are stacked and scaled to 100%.
- PIE - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelChartConfig.ChartType
-
Pie chart.
- PINK - Static variable in class io.github.dornol.excelkit.excel.ExcelColor
-
Pink (255, 192, 203).
- PIPE - Enum constant in enum class io.github.dornol.excelkit.csv.CsvDialect
-
Pipe-separated values: pipe delimiter, UTF-8, no BOM.
- plusRow() - Method in class io.github.dornol.excelkit.core.Cursor
-
Increments the current row index in the current sheet by 1.
- plusTotal() - Method in class io.github.dornol.excelkit.core.Cursor
-
Increments the total number of processed rows (across all sheets) by 1.
- png(byte[]) - Static method in record class io.github.dornol.excelkit.excel.ExcelImage
-
Creates a PNG image.
- PORTRAIT - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelPrintSetup.Orientation
-
Portrait orientation (taller than wide).
- position(int, int, int, int) - Method in class io.github.dornol.excelkit.excel.ExcelChartConfig
-
Sets the chart position in the sheet.
- printSetup(Consumer<ExcelPrintSetup>) - Method in class io.github.dornol.excelkit.excel.ExcelSheetWriter
-
Configures print setup (page layout) for the sheet(s).
- printSetup(Consumer<ExcelPrintSetup>) - Method in class io.github.dornol.excelkit.excel.ExcelWriter
-
Configures print setup (page layout) for all sheets.
- ProgressCallback - Interface in io.github.dornol.excelkit.core
-
Callback for reporting progress during large Excel/CSV writes.
- protectSheet(String) - Method in class io.github.dornol.excelkit.excel.ExcelSheetWriter
-
Protects the sheet(s) with the given password.
- protectSheet(String) - Method in class io.github.dornol.excelkit.excel.ExcelWriter
-
Protects all sheets with the given password.
- protectWorkbook(String) - Method in class io.github.dornol.excelkit.excel.ExcelWorkbook
-
Protects the workbook structure with the given password.
- protectWorkbook(String) - Method in class io.github.dornol.excelkit.excel.ExcelWriter
-
Protects the workbook structure with the given password.
- PURPLE - Static variable in class io.github.dornol.excelkit.excel.ExcelColor
-
Purple (128, 0, 128).
Q
- QUARTERS_5 - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelConditionalRule.IconSetType
-
5 quarters icon set.
- quoting(CsvQuoting) - Method in class io.github.dornol.excelkit.csv.CsvWriter
-
Sets the quoting strategy for CSV field values.
R
- RATINGS_4 - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelConditionalRule.IconSetType
-
4 ratings icon set.
- RATINGS_5 - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelConditionalRule.IconSetType
-
5 ratings icon set.
- read(Consumer<ReadResult<T>>) - Method in class io.github.dornol.excelkit.core.AbstractReadHandler
-
Reads the file and invokes the given consumer for each row result.
- read(Consumer<ReadResult<T>>) - Method in class io.github.dornol.excelkit.csv.CsvReadHandler
- read(Consumer<ReadResult<T>>) - Method in class io.github.dornol.excelkit.excel.ExcelReadHandler
-
Starts parsing the Excel file and invokes the given consumer for each row result.
- ReadAbortException - Exception Class in io.github.dornol.excelkit.core
-
Exception thrown by
AbstractReadHandler.readStrict(java.util.function.Consumer)when a row fails validation or mapping. - ReadAbortException(String) - Constructor for exception class io.github.dornol.excelkit.core.ReadAbortException
-
Creates an exception with the given message.
- readAsStream() - Method in class io.github.dornol.excelkit.core.AbstractReadHandler
-
Reads the file and returns a lazy stream of row results.
- readAsStream() - Method in class io.github.dornol.excelkit.csv.CsvReadHandler
-
Reads the CSV file as a stream of row results.
- readAsStream() - Method in class io.github.dornol.excelkit.excel.ExcelReadHandler
-
Reads the file as a stream of row results using a background producer thread.
- ReadColumn<T> - Record Class in io.github.dornol.excelkit.core
-
Represents a single column binding for reading (Excel or CSV).
- ReadColumn(String, int, BiConsumer<T, CellData>) - Constructor for record class io.github.dornol.excelkit.core.ReadColumn
-
Creates a column binding with explicit index.
- ReadColumn(String, int, BiConsumer<T, CellData>, boolean) - Constructor for record class io.github.dornol.excelkit.core.ReadColumn
-
Creates an instance of a
ReadColumnrecord class. - ReadColumn(String, BiConsumer<T, CellData>) - Constructor for record class io.github.dornol.excelkit.core.ReadColumn
-
Creates a name-based column binding.
- ReadColumn(BiConsumer<T, CellData>) - Constructor for record class io.github.dornol.excelkit.core.ReadColumn
-
Creates a positional column binding (matched by column index order).
- ReadResult<T> - Record Class in io.github.dornol.excelkit.core
-
Represents the result of reading a single row from an Excel file.
- ReadResult(T, boolean, List<String>) - Constructor for record class io.github.dornol.excelkit.core.ReadResult
-
Creates an instance of a
ReadResultrecord class. - readSetter() - Method in record class io.github.dornol.excelkit.core.ExcelKitSchema.SchemaColumn
-
Returns the value of the
readSetterrecord component. - readStrict(Consumer<T>) - Method in class io.github.dornol.excelkit.core.AbstractReadHandler
-
Reads the file and invokes the given consumer only for successfully parsed rows.
- RED - Static variable in class io.github.dornol.excelkit.excel.ExcelColor
-
Red (255, 0, 0).
- repeatHeaderRows() - Method in class io.github.dornol.excelkit.excel.ExcelPrintSetup
-
Repeats header rows (from row 0 through the column header row) on every printed page.
- repeatRows(int, int) - Method in class io.github.dornol.excelkit.excel.ExcelPrintSetup
-
Repeats specific rows on every printed page.
- required() - Method in record class io.github.dornol.excelkit.core.ReadColumn
-
Returns a copy of this column marked as required.
- required() - Method in class io.github.dornol.excelkit.csv.CsvReader
-
Marks the last registered column as required.
- required() - Method in class io.github.dornol.excelkit.excel.ExcelReader
-
Marks the last registered column as required.
- resetDateFormats() - Static method in record class io.github.dornol.excelkit.core.CellData
-
Resets the date format patterns to the built-in defaults.
- resetDateTimeFormats() - Static method in record class io.github.dornol.excelkit.core.CellData
-
Resets the date-time format patterns to the built-in defaults.
- resolveColumnIndices(int, IntFunction<String>, IntUnaryOperator, List<String>, String) - Method in class io.github.dornol.excelkit.core.AbstractReadHandler
-
Resolves column indices based on headerName, columnIndex, or positional order.
- Resource management - Search tag in class io.github.dornol.excelkit.csv.CsvReadHandler
- Section
- Resource management - Search tag in class io.github.dornol.excelkit.excel.ExcelReadHandler
- Section
- RFC4180 - Enum constant in enum class io.github.dornol.excelkit.csv.CsvDialect
-
RFC 4180 standard: comma delimiter, UTF-8, no BOM.
- RICH_TEXT - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelDataType
-
Rich text type.
- RIGHT - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelChartConfig.LegendPosition
-
Right position.
- rightMargin(double) - Method in class io.github.dornol.excelkit.excel.ExcelPrintSetup
-
Sets the right margin.
- rotation(int) - Method in class io.github.dornol.excelkit.excel.ColumnStyleConfig
-
Sets the text rotation angle for this column's cells.
- rowAccessWindowSize(int) - Method in class io.github.dornol.excelkit.excel.ExcelWorkbook.InitOptions
-
Sets the SXSSF row access window size.
- rowAccessWindowSize(int) - Method in class io.github.dornol.excelkit.excel.ExcelWriter.InitOptions
-
Sets the number of rows kept in memory by the underlying SXSSFWorkbook.
- rowColor(Function<T, ExcelColor>) - Method in class io.github.dornol.excelkit.excel.ExcelSheetWriter
-
Sets a function that determines the background color for each row.
- rowColor(Function<T, ExcelColor>) - Method in class io.github.dornol.excelkit.excel.ExcelWriter
-
Sets a function that determines the background color for each row.
- rowColor(Function<T, ExcelColor>) - Method in class io.github.dornol.excelkit.excel.TemplateListWriter
-
Sets a function that determines the background color for each row.
- RowData - Class in io.github.dornol.excelkit.core
-
Provides access to all cell data in a single row, indexed by header name or column position.
- RowData(List<CellData>, List<String>, Map<String, Integer>) - Constructor for class io.github.dornol.excelkit.core.RowData
-
Constructs a RowData instance.
- RowFunction<T,
R> - Interface in io.github.dornol.excelkit.core -
A functional interface for mapping a row of data to a cell value, with optional cursor access.
- rowHeight(float) - Method in class io.github.dornol.excelkit.excel.ExcelSheetWriter
-
Sets the row height for data rows in points.
- rowHeight(float) - Method in class io.github.dornol.excelkit.excel.ExcelWriter
-
Sets the row height for data rows in points.
- rowHeight(float) - Method in class io.github.dornol.excelkit.excel.TemplateListWriter
-
Sets the row height for data rows in points.
- rowMapper - Variable in class io.github.dornol.excelkit.core.AbstractReadHandler
-
Function for mapping row data to instances (mapping mode).
S
- SCATTER - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelChartConfig.ChartType
-
Scatter (XY) chart.
- SchemaColumn(String, Function<T, Object>, BiConsumer<T, CellData>) - Constructor for record class io.github.dornol.excelkit.core.ExcelKitSchema.SchemaColumn
-
Creates a schema column without write configuration.
- SchemaColumn(String, Function<T, Object>, BiConsumer<T, CellData>, Consumer<ExcelColumn.ExcelColumnBuilder<T>>) - Constructor for record class io.github.dornol.excelkit.core.ExcelKitSchema.SchemaColumn
-
Creates an instance of a
SchemaColumnrecord class. - setDefaultLocale(Locale) - Static method in record class io.github.dornol.excelkit.core.CellData
-
Sets the default locale for number parsing.
- setRowOfSheet(int) - Method in class io.github.dornol.excelkit.core.Cursor
-
Sets the current sheet's row index to the given value.
- setTempDir(Path) - Method in class io.github.dornol.excelkit.core.TempResourceContainer
-
Sets the path to the temporary directory.
- setTempFile(Path) - Method in class io.github.dornol.excelkit.core.TempResourceContainer
-
Sets the path to the temporary file.
- setter() - Method in record class io.github.dornol.excelkit.core.ReadColumn
-
Returns the value of the
setterrecord component. - setter(Supplier<T>) - Static method in class io.github.dornol.excelkit.csv.CsvReader
-
Creates a CsvReader in setter mode.
- setter(Supplier<T>) - Static method in class io.github.dornol.excelkit.excel.ExcelReader
-
Creates an ExcelReader in setter mode.
- setter(Supplier<T>, Validator) - Static method in class io.github.dornol.excelkit.csv.CsvReader
-
Creates a CsvReader in setter mode with Bean Validation.
- setter(Supplier<T>, Validator) - Static method in class io.github.dornol.excelkit.excel.ExcelReader
-
Creates an ExcelReader in setter mode with Bean Validation.
- sheet(int) - Method in class io.github.dornol.excelkit.excel.ExcelTemplateWriter
-
Selects the active sheet by index for subsequent
ExcelTemplateWriter.cell(java.lang.String, java.lang.Object)calls. - sheet(String) - Method in class io.github.dornol.excelkit.excel.ExcelTemplateWriter
-
Selects the active sheet by name for subsequent
ExcelTemplateWriter.cell(java.lang.String, java.lang.Object)calls. - sheet(String) - Method in class io.github.dornol.excelkit.excel.ExcelWorkbook
-
Creates a new sheet with the given name and returns a typed writer for it.
- SheetContext - Class in io.github.dornol.excelkit.excel
-
Provides contextual information passed to
BeforeHeaderWriterandAfterDataWritercallbacks, including the current sheet, workbook, row position, and column metadata. - sheetIndex(int) - Method in class io.github.dornol.excelkit.excel.ExcelReader
-
Sets the zero-based sheet index to read from.
- sheetName(String) - Method in class io.github.dornol.excelkit.excel.ExcelWriter
-
Sets a fixed sheet name.
- sheetName(Function<Integer, String>) - Method in class io.github.dornol.excelkit.excel.ExcelSheetWriter
-
Sets a function that generates sheet names for rollover sheets.
- sheetName(Function<Integer, String>) - Method in class io.github.dornol.excelkit.excel.ExcelWriter
-
Sets a function that generates sheet names based on the sheet index (0-based).
- showDataLabels(boolean) - Method in class io.github.dornol.excelkit.excel.ExcelChartConfig
-
Sets whether data labels (values) are shown on chart data points.
- showError(boolean) - Method in class io.github.dornol.excelkit.excel.ExcelValidation
-
Sets whether to show the error dialog when validation fails.
- SIGNS_3 - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelConditionalRule.IconSetType
-
3 signs icon set.
- size() - Method in class io.github.dornol.excelkit.core.RowData
-
Returns the number of cells in this row.
- size(int, int) - Method in record class io.github.dornol.excelkit.excel.ExcelCellComment
-
Returns a copy with the given box size (in cells × rows).
- skipColumn() - Method in class io.github.dornol.excelkit.csv.CsvReader
-
Skips one column during reading by registering a no-op mapping.
- skipColumn() - Method in class io.github.dornol.excelkit.excel.ExcelReader
-
Skips one column during reading by registering a no-op mapping at the next positional slot.
- skipColumns(int) - Method in class io.github.dornol.excelkit.csv.CsvReader
-
Skips the specified number of positional columns.
- skipColumns(int) - Method in class io.github.dornol.excelkit.excel.ExcelReader
-
Skips the specified number of positional columns.
- STACKED - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelChartConfig.BarGrouping
-
Series are stacked on top of each other.
- STANDARD - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelChartConfig.BarGrouping
-
Each series is drawn side by side.
- startRow(int) - Method in class io.github.dornol.excelkit.excel.ExcelConditionalRule
-
Sets the starting data row (0-based).
- STEEL_BLUE - Static variable in class io.github.dornol.excelkit.excel.ExcelColor
-
Steel blue (70, 130, 180).
- strikethrough() - Method in class io.github.dornol.excelkit.excel.ColumnStyleConfig
-
Enables strikethrough on this column's font.
- strikethrough(boolean) - Method in class io.github.dornol.excelkit.excel.ColumnStyleConfig
-
Sets whether this column's font should be strikethrough.
- strikethrough(boolean) - Method in class io.github.dornol.excelkit.excel.ExcelRichText.FontStyle
-
Sets strikethrough styling.
- STRING - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelDataType
-
Generic string type.
- style(CellStyle) - Method in class io.github.dornol.excelkit.excel.ExcelColumn.ExcelColumnBuilder
-
Sets a custom
CellStylefor this column. - styled(String, Consumer<ExcelRichText.FontStyle>) - Method in class io.github.dornol.excelkit.excel.ExcelRichText
-
Appends text with fully customized font styling.
- success() - Method in record class io.github.dornol.excelkit.core.ReadResult
-
Returns the value of the
successrecord component. - sum(String) - Method in class io.github.dornol.excelkit.excel.ExcelSummary
-
Adds a SUM formula for the specified column.
- SUM - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelSummary.Op
-
Sum formula.
- summary(Consumer<ExcelSummary>) - Method in class io.github.dornol.excelkit.excel.ExcelSheetWriter
-
Configures summary (footer) rows with formulas such as SUM, AVERAGE, COUNT, MIN, MAX.
- summary(Consumer<ExcelSummary>) - Method in class io.github.dornol.excelkit.excel.ExcelWriter
-
Configures summary (footer) rows with formulas such as SUM, AVERAGE, COUNT, MIN, MAX.
- summary(Consumer<ExcelSummary>) - Method in class io.github.dornol.excelkit.excel.TemplateListWriter
-
Configures summary (footer) rows with formulas.
- SYMBOLS_3 - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelConditionalRule.IconSetType
-
3 symbols icon set.
T
- tabColor(int, int, int) - Method in class io.github.dornol.excelkit.excel.ExcelSheetWriter
-
Sets the sheet tab color using RGB values.
- tabColor(int, int, int) - Method in class io.github.dornol.excelkit.excel.ExcelWriter
-
Sets the sheet tab color using RGB values.
- tabColor(ExcelColor) - Method in class io.github.dornol.excelkit.excel.ExcelSheetWriter
-
Sets the sheet tab color using a preset color.
- tabColor(ExcelColor) - Method in class io.github.dornol.excelkit.excel.ExcelWriter
-
Sets the sheet tab color using a preset color.
- TEAL - Static variable in class io.github.dornol.excelkit.excel.ExcelColor
-
Teal (0, 128, 128).
- TemplateListWriter<T> - Class in io.github.dornol.excelkit.excel
-
Writes tabular (list) data into an existing template sheet starting at a given row.
- TempResourceContainer - Class in io.github.dornol.excelkit.core
-
Abstract container class for managing temporary files and directories.
- TempResourceContainer() - Constructor for class io.github.dornol.excelkit.core.TempResourceContainer
-
Creates a new empty temp resource container.
- TempResourceCreateException - Exception Class in io.github.dornol.excelkit.core
-
Exception thrown when a temporary resource (file or directory) cannot be created.
- TempResourceCreateException(Throwable) - Constructor for exception class io.github.dornol.excelkit.core.TempResourceCreateException
-
Constructs a new TempResourceCreateException with the specified cause.
- TempResourceCreator - Class in io.github.dornol.excelkit.core
-
Utility class for creating temporary files and directories with appropriate permissions.
- text() - Method in record class io.github.dornol.excelkit.excel.ExcelCellComment
-
Returns the value of the
textrecord component. - text(String) - Method in class io.github.dornol.excelkit.excel.ExcelRichText
-
Appends plain (unstyled) text.
- TEXT_LENGTH - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelValidation.ValidationType
-
Text length validation.
- textLength(int, int) - Static method in class io.github.dornol.excelkit.excel.ExcelValidation
-
Creates a validation that restricts text length between min and max (inclusive).
- THICK - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelBorderStyle
-
Thick border.
- THIN - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelBorderStyle
-
Thin border.
- TIME - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelDataFormat
-
Time only format (e.g., 14:23:00)
- TIME - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelDataType
-
LocalTime formatted as "HH:mm:ss".
- title(String) - Method in class io.github.dornol.excelkit.excel.ExcelChartConfig
-
Sets the chart title.
- TOP - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelChartConfig.LegendPosition
-
Top position.
- TOP_RIGHT - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelChartConfig.LegendPosition
-
Top-right position.
- topMargin(double) - Method in class io.github.dornol.excelkit.excel.ExcelPrintSetup
-
Sets the top margin.
- toRgb() - Method in class io.github.dornol.excelkit.excel.ExcelColor
-
Returns the color as an RGB array.
- toString() - Method in record class io.github.dornol.excelkit.core.CellData
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.dornol.excelkit.core.ExcelKitSchema.SchemaColumn
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.dornol.excelkit.core.ReadColumn
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.dornol.excelkit.core.ReadResult
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.dornol.excelkit.excel.ExcelCellComment
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.dornol.excelkit.excel.ExcelHyperlink
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.dornol.excelkit.excel.ExcelImage
-
Returns a string representation of this record class.
- toString() - Method in class io.github.dornol.excelkit.excel.ExcelRichText
-
Returns the plain text content (without formatting) for display or width calculation.
- toString() - Method in record class io.github.dornol.excelkit.excel.ExcelSheetInfo
-
Returns a string representation of this record class.
- TRAFFIC_LIGHTS_3 - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelConditionalRule.IconSetType
-
3 traffic lights icon set.
- TSV - Enum constant in enum class io.github.dornol.excelkit.csv.CsvDialect
-
Tab-separated values: tab delimiter, UTF-8, no BOM.
- type(ExcelChartConfig.ChartType) - Method in class io.github.dornol.excelkit.excel.ExcelChartConfig
-
Sets the chart type.
- type(ExcelDataType) - Method in class io.github.dornol.excelkit.excel.ColumnStyleConfig
-
Sets the column's data type (used for styling and value conversion).
U
- underline() - Method in class io.github.dornol.excelkit.excel.ColumnStyleConfig
-
Enables underline on this column's font.
- underline(boolean) - Method in class io.github.dornol.excelkit.excel.ColumnStyleConfig
-
Sets whether this column's font should be underlined.
- underline(boolean) - Method in class io.github.dornol.excelkit.excel.ExcelRichText.FontStyle
-
Sets underline styling.
- url() - Method in record class io.github.dornol.excelkit.excel.ExcelHyperlink
-
Returns the value of the
urlrecord component.
V
- validateColumns(List<?>) - Static method in class io.github.dornol.excelkit.core.AbstractReadHandler
-
Validates that the columns list is non-null and non-empty.
- validateHeaderRowIndex(int) - Static method in class io.github.dornol.excelkit.core.AbstractReadHandler
-
Validates that headerRowIndex is non-negative.
- validateIfNeeded(T, List<String>) - Method in class io.github.dornol.excelkit.core.AbstractReadHandler
-
Validates the given instance using Bean Validation (if a validator is configured).
- validation(ExcelValidation) - Method in class io.github.dornol.excelkit.excel.ColumnStyleConfig
-
Sets advanced data validation for this column.
- validator - Variable in class io.github.dornol.excelkit.core.AbstractReadHandler
-
Optional bean validator for row validation.
- valueAxisTitle(String) - Method in class io.github.dornol.excelkit.excel.ExcelChartConfig
-
Sets the value axis (Y-axis) title.
- valueColumn(int, String) - Method in class io.github.dornol.excelkit.excel.ExcelChartConfig
-
Adds a value (Y-axis) series from the specified column.
- valueOf(String) - Static method in enum class io.github.dornol.excelkit.csv.CsvDialect
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.github.dornol.excelkit.csv.CsvQuoting
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.github.dornol.excelkit.excel.ExcelBorderStyle
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.github.dornol.excelkit.excel.ExcelChartConfig.BarDirection
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.github.dornol.excelkit.excel.ExcelChartConfig.BarGrouping
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.github.dornol.excelkit.excel.ExcelChartConfig.ChartType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.github.dornol.excelkit.excel.ExcelChartConfig.LegendPosition
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.github.dornol.excelkit.excel.ExcelConditionalRule.IconSetType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.github.dornol.excelkit.excel.ExcelDataFormat
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.github.dornol.excelkit.excel.ExcelDataType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.github.dornol.excelkit.excel.ExcelPrintSetup.Orientation
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.github.dornol.excelkit.excel.ExcelPrintSetup.PaperSize
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.github.dornol.excelkit.excel.ExcelSummary.Op
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.github.dornol.excelkit.excel.ExcelValidation.ValidationType
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class io.github.dornol.excelkit.csv.CsvDialect
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.github.dornol.excelkit.csv.CsvQuoting
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.github.dornol.excelkit.excel.ExcelBorderStyle
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.github.dornol.excelkit.excel.ExcelChartConfig.BarDirection
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.github.dornol.excelkit.excel.ExcelChartConfig.BarGrouping
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.github.dornol.excelkit.excel.ExcelChartConfig.ChartType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.github.dornol.excelkit.excel.ExcelChartConfig.LegendPosition
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.github.dornol.excelkit.excel.ExcelConditionalRule.IconSetType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.github.dornol.excelkit.excel.ExcelDataFormat
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.github.dornol.excelkit.excel.ExcelDataType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.github.dornol.excelkit.excel.ExcelPrintSetup.Orientation
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.github.dornol.excelkit.excel.ExcelPrintSetup.PaperSize
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.github.dornol.excelkit.excel.ExcelSummary.Op
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.github.dornol.excelkit.excel.ExcelValidation.ValidationType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- VERTICAL - Enum constant in enum class io.github.dornol.excelkit.excel.ExcelChartConfig.BarDirection
-
Bars are drawn as vertical columns.
- verticalAlignment(VerticalAlignment) - Method in class io.github.dornol.excelkit.excel.ColumnStyleConfig
-
Sets the column's vertical text alignment.
W
- WHITE - Static variable in class io.github.dornol.excelkit.excel.ExcelColor
-
White (255, 255, 255).
- width() - Method in record class io.github.dornol.excelkit.excel.ExcelCellComment
-
Returns the value of the
widthrecord component. - width(int) - Method in class io.github.dornol.excelkit.excel.ColumnStyleConfig
-
Sets a fixed column width.
- wrapText() - Method in class io.github.dornol.excelkit.excel.ColumnStyleConfig
-
Enables text wrapping for this column's cells.
- wrapText(boolean) - Method in class io.github.dornol.excelkit.excel.ColumnStyleConfig
-
Sets whether text wrapping is enabled for this column's cells.
- write(SheetContext) - Method in interface io.github.dornol.excelkit.excel.AfterDataWriter
-
Writes custom content to the sheet after the data rows.
- write(SheetContext) - Method in interface io.github.dornol.excelkit.excel.BeforeHeaderWriter
-
Writes custom content to the sheet before the column headers.
- write(PrintWriter) - Method in interface io.github.dornol.excelkit.csv.CsvAfterDataWriter
-
Writes custom content after all data rows.
- write(Stream<T>) - Method in class io.github.dornol.excelkit.csv.CsvWriter
-
Writes the given stream of rows to a temporary CSV file.
- write(Stream<T>) - Method in class io.github.dornol.excelkit.excel.ExcelSheetWriter
-
Writes the data stream to this sheet (with optional auto-rollover).
- write(Stream<T>) - Method in class io.github.dornol.excelkit.excel.ExcelWriter
-
Writes the stream of row data into Excel file without row-level callback.
- write(Stream<T>) - Method in class io.github.dornol.excelkit.excel.TemplateListWriter
-
Writes the data stream to this sheet starting at the configured start row.
- write(Stream<T>, WriteRowCallback<T>) - Method in class io.github.dornol.excelkit.excel.ExcelWriter
-
Writes the stream of row data into an Excel file using custom row-level callback.
- writeConfigurer() - Method in record class io.github.dornol.excelkit.core.ExcelKitSchema.SchemaColumn
-
Returns the value of the
writeConfigurerrecord component. - writeFunction() - Method in record class io.github.dornol.excelkit.core.ExcelKitSchema.SchemaColumn
-
Returns the value of the
writeFunctionrecord component. - WriteRowCallback<T> - Interface in io.github.dornol.excelkit.excel
-
A functional interface for consuming row data during Excel export.
- writeTo(OutputStream) - Method in interface io.github.dornol.excelkit.core.FileHandler
-
Writes the generated file content to the given output stream.
- writeTo(OutputStream) - Method in class io.github.dornol.excelkit.csv.CsvHandler
-
Writes the content of the CSV file to the given OutputStream.
- writeTo(OutputStream) - Method in class io.github.dornol.excelkit.excel.ExcelHandler
-
Writes the workbook to the given OutputStream.
- writeTo(OutputStream, char[]) - Method in class io.github.dornol.excelkit.excel.ExcelHandler
-
Writes the workbook to the given OutputStream with Excel-compatible password encryption.
- writeTo(OutputStream, String) - Method in class io.github.dornol.excelkit.excel.ExcelHandler
-
Writes the workbook to the given OutputStream with Excel-compatible password encryption.
- writeTo(Path) - Method in interface io.github.dornol.excelkit.core.FileHandler
-
Writes the generated file content directly to a file path.
- writeTo(Path, char[]) - Method in class io.github.dornol.excelkit.excel.ExcelHandler
-
Writes the workbook directly to a file path with Excel-compatible password encryption.
- writeTo(Path, String) - Method in class io.github.dornol.excelkit.excel.ExcelHandler
-
Writes the workbook directly to a file path with Excel-compatible password encryption.
- writeWithHeaders(Stream<T>) - Method in class io.github.dornol.excelkit.excel.TemplateListWriter
-
Writes column headers at the start row, followed by data rows.
Y
- YELLOW - Static variable in class io.github.dornol.excelkit.excel.ExcelColor
-
Yellow (255, 255, 0).
All Classes and Interfaces|All Packages|Serialized Form