Package io.github.dornol.excelkit.core

Record Class ExcelKitSchema.SchemaColumn<T>

java.lang.Object
java.lang.Record
io.github.dornol.excelkit.core.ExcelKitSchema.SchemaColumn<T>
Type Parameters:
T - The row data type
Record Components:
name - Column header name
writeFunction - Function to extract the cell value from a row object
readSetter - BiConsumer to set the cell value into a row object
writeConfigurer - Optional consumer to configure Excel column properties (type, format, etc.)
Enclosing class:
ExcelKitSchema<T>
public static record ExcelKitSchema.SchemaColumn<T>(String name, Function<T,@Nullable Object> writeFunction, BiConsumer<T,CellData> readSetter, @Nullable Consumer<ExcelColumn.ExcelColumnBuilder<T>> writeConfigurer) extends Record
Represents a single column definition in the schema.

  • Constructor Details

    • SchemaColumn

      public SchemaColumn(String name, Function<T,@Nullable Object> writeFunction, BiConsumer<T,CellData> readSetter)
      Creates a schema column without write configuration.
      Parameters:
      name - the column header name
      writeFunction - function to extract the cell value
      readSetter - consumer to set the cell value

    • SchemaColumn

      public SchemaColumn(String name, Function<T,@Nullable Object> writeFunction, BiConsumer<T,CellData> readSetter, @Nullable Consumer<ExcelColumn.ExcelColumnBuilder<T>> writeConfigurer)
      Creates an instance of a SchemaColumn record class.
      Parameters:
      name - the value for the name record component
      writeFunction - the value for the writeFunction record component
      readSetter - the value for the readSetter record component
      writeConfigurer - the value for the writeConfigurer record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • name

      public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • writeFunction

      public Function<T,@Nullable Object> writeFunction()
      Returns the value of the writeFunction record component.
      Returns:
      the value of the writeFunction record component

    • readSetter

      public BiConsumer<T,CellData> readSetter()
      Returns the value of the readSetter record component.
      Returns:
      the value of the readSetter record component

    • writeConfigurer

      public @Nullable Consumer<ExcelColumn.ExcelColumnBuilder<T>> writeConfigurer()
      Returns the value of the writeConfigurer record component.
      Returns:
      the value of the writeConfigurer record component