Package org.miaixz.bus.office.csv

Class CsvConfig<T extends CsvConfig<T>>

java.lang.Object
org.miaixz.bus.office.csv.CsvConfig<T>
Type Parameters:
T - 继承子类类型，用于this返回
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
CsvReadConfig, CsvWriteConfig
public class CsvConfig<T extends CsvConfig<T>> extends Object implements Serializable
CSV基础配置项，此配置项可用于读取和写出CSV，定义了包括字段分隔符、文本包装符等符号
Since:
Java 17+
Author:
Kimi Liu
See Also:

  • Field Details

    • fieldSeparator

      protected char fieldSeparator
      字段分隔符，默认逗号','

    • textDelimiter

      protected char textDelimiter
      文本包装符，默认双引号'"'

    • commentCharacter

      protected Character commentCharacter
      注释符号，用于区分注释行，默认'#'

    • headerAlias

      protected Map<String,String> headerAlias
      标题别名

  • Constructor Details

    • CsvConfig

      public CsvConfig()

  • Method Details

    • setFieldSeparator

      public T setFieldSeparator(char fieldSeparator)
      设置字段分隔符，默认逗号','
      Parameters:
      fieldSeparator - 字段分隔符，默认逗号','
      Returns:
      this

    • setTextDelimiter

      public T setTextDelimiter(char textDelimiter)
      设置 文本分隔符，文本包装符，默认双引号'"'
      Parameters:
      textDelimiter - 文本分隔符，文本包装符，默认双引号'"'
      Returns:
      this

    • disableComment

      public T disableComment()
      设置注释无效 当写出CSV时，CsvWriter.writeComment(String)将抛出异常 当读取CSV时，注释行按照正常行读取
      Returns:
      this

    • setCommentCharacter

      public T setCommentCharacter(Character commentCharacter)
      设置 注释符号，用于区分注释行，null表示忽略注释
      Parameters:
      commentCharacter - 注释符号，用于区分注释行
      Returns:
      this

    • setHeaderAlias

      public T setHeaderAlias(Map<String,String> headerAlias)
      设置标题行的别名Map
      Parameters:
      headerAlias - 别名Map
      Returns:
      this

    • addHeaderAlias

      public T addHeaderAlias(String header, String alias)
      增加标题别名
      Parameters:
      header - 标题
      alias - 别名
      Returns:
      this

    • removeHeaderAlias

      public T removeHeaderAlias(String header)
      去除标题别名
      Parameters:
      header - 标题
      Returns:
      this