程序包 com.sh.wf.excel.write.builder

类 ExcelWriterBuilder

java.lang.Object
com.sh.wf.excel.write.builder.ExcelWriterBuilder
public class ExcelWriterBuilder extends Object
Build ExcelBuilder

  • 构造器详细资料

    • ExcelWriterBuilder

      public ExcelWriterBuilder()

  • 方法详细资料

    • relativeHeadRowIndex

      public ExcelWriterBuilder relativeHeadRowIndex(Integer relativeHeadRowIndex)
      Writes the head relative to the existing contents of the sheet. Indexes are zero-based.
      参数:
      relativeHeadRowIndex - Integer
      返回:
      ExcelWriterBuilder

    • head

      public ExcelWriterBuilder head(List<List<String>> head)
      You can only choose one of the head(List) and head(Class)
      参数:
      head - List
      返回:
      ExcelWriterBuilder

    • head

      public ExcelWriterBuilder head(Class clazz)
      You can only choose one of the head(List) and head(Class)
      参数:
      clazz - Class
      返回:
      ExcelWriterBuilder

    • needHead

      public ExcelWriterBuilder needHead(Boolean needHead)

    • autoCloseStream

      public ExcelWriterBuilder autoCloseStream(Boolean autoCloseStream)
      Default true
      参数:
      autoCloseStream - Boolean
      返回:
      ExcelWriterBuilder

    • useDefaultStyle

      public ExcelWriterBuilder useDefaultStyle(Boolean useDefaultStyle)
      Use the default style.Default is true.
      参数:
      useDefaultStyle - Boolean
      返回:
      ExcelWriterBuilder

    • automaticMergeHead

      public ExcelWriterBuilder automaticMergeHead(Boolean automaticMergeHead)
      Whether to automatically merge headers.Default is true.
      参数:
      automaticMergeHead - Boolean
      返回:
      ExcelWriterBuilder

    • password

      public ExcelWriterBuilder password(String password)
      Whether the encryption. WARRING:Encryption is when the entire file is read into memory, so it is very memory intensive.
      参数:
      password - String
      返回:
      ExcelWriterBuilder

    • inMemory

      public ExcelWriterBuilder inMemory(Boolean inMemory)
      Write excel in memory. Default false,the cache file is created and finally written to excel. Comment and RichTextString are only supported in memory mode.
      参数:
      inMemory - Boolean
      返回:
      ExcelWriterBuilder

    • excludeColumnIndexes

      public ExcelWriterBuilder excludeColumnIndexes(Collection<Integer> excludeColumnIndexes)
      Ignore the custom columns.
      参数:
      excludeColumnIndexes - Collection
      返回:
      ExcelWriterBuilder

    • excludeColumnFiledNames

      public ExcelWriterBuilder excludeColumnFiledNames(Collection<String> excludeColumnFiledNames)
      Ignore the custom columns.
      参数:
      excludeColumnFiledNames - Collection
      返回:
      ExcelWriterBuilder

    • includeColumnIndexes

      public ExcelWriterBuilder includeColumnIndexes(Collection<Integer> includeColumnIndexes)
      Only output the custom columns.
      参数:
      includeColumnIndexes - Collection
      返回:
      ExcelWriterBuilder

    • includeColumnFiledNames

      public ExcelWriterBuilder includeColumnFiledNames(Collection<String> includeColumnFiledNames)
      Only output the custom columns.
      参数:
      includeColumnFiledNames - Collection
      返回:
      ExcelWriterBuilder

    • writeExcelOnException

      public ExcelWriterBuilder writeExcelOnException(Boolean writeExcelOnException)
      Excel is also written in the event of an exception being thrown.The default false.
      参数:
      writeExcelOnException - Collection
      返回:
      ExcelWriterBuilder

    • convertAllFiled

      @Deprecated public ExcelWriterBuilder convertAllFiled(Boolean convertAllFiled)
      已过时。
      Just to be compatible with historical data, The default is always going to be convert all filed.
      The default is all excel objects.if true , you can use ExcelIgnore ignore a field. if false , you must use ExcelProperty to use a filed.

      Default true

      参数:
      convertAllFiled - Boolean
      返回:
      ExcelWriterBuilder

    • registerConverter

      public ExcelWriterBuilder registerConverter(Converter converter)
      Custom type conversions override the default.
      参数:
      converter - Converter
      返回:
      ExcelWriterBuilder

    • registerWriteHandler

      public ExcelWriterBuilder registerWriteHandler(WriteHandler writeHandler)
      Custom write handler
      参数:
      writeHandler - WriteHandler
      返回:
      ExcelWriterBuilder

    • excelType

      public ExcelWriterBuilder excelType(ExcelTypeEnum excelType)

    • file

      public ExcelWriterBuilder file(OutputStream outputStream)

    • file

      public ExcelWriterBuilder file(File outputFile)

    • file

      public ExcelWriterBuilder file(String outputPathName)

    • withTemplate

      public ExcelWriterBuilder withTemplate(InputStream templateInputStream)

    • withTemplate

      public ExcelWriterBuilder withTemplate(File templateFile)

    • withTemplate

      public ExcelWriterBuilder withTemplate(String pathName)

    • registerWriteHandler

      @Deprecated public ExcelWriterBuilder registerWriteHandler(WriteHandler writeHandler)
      已过时。
      please use WriteHandler
      Write handler
      参数:
      writeHandler - WriteHandler
      返回:
      ExcelWriterBuilder

    • build

      public ExcelWriter build()

    • sheet

      public ExcelWriterSheetBuilder sheet()

    • sheet

      public ExcelWriterSheetBuilder sheet(Integer sheetNo)

    • sheet

      public ExcelWriterSheetBuilder sheet(String sheetName)

    • sheet

      public ExcelWriterSheetBuilder sheet(Integer sheetNo, String sheetName)