com.alibaba.excel.read.builder.AbstractExcelReaderParameterBuilder Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of easyexcel Show documentation

easyexcel is a excel handle tools written in Java

There is a newer version: 4.0.3

package com.alibaba.excel.read.builder;

import java.util.ArrayList;

import com.alibaba.excel.metadata.AbstractParameterBuilder;
import com.alibaba.excel.read.listener.ReadListener;
import com.alibaba.excel.read.metadata.ReadBasicParameter;

/**
 * Build ExcelBuilder
 *
 * @author Jiaju Zhuang
 */
public abstract class AbstractExcelReaderParameterBuilder extends AbstractParameterBuilder {
    /**
     * Count the number of added heads when read sheet.
     *
     * 
     * 0 - This Sheet has no head ,since the first row are the data
     * 

     * 1 - This Sheet has one row head , this is the default
     * 
     * 2 - This Sheet has two row head ,since the third row is the data
     *
     * @param headRowNumber
     * @return
     */
    public T headRowNumber(Integer headRowNumber) {
        parameter().setHeadRowNumber(headRowNumber);
        return self();
    }

    /**
     * Whether to use scientific Format.
     *
     * default is false
     *
     * @param useScientificFormat
     * @return
     */
    public T useScientificFormat(Boolean useScientificFormat) {
        parameter().setUseScientificFormat(useScientificFormat);
        return self();
    }

    /**
     * Custom type listener run after default
     *
     * @param readListener
     * @return
     */
    public T registerReadListener(ReadListener readListener) {
        if (parameter().getCustomReadListenerList() == null) {
            parameter().setCustomReadListenerList(new ArrayList());
        }
        parameter().getCustomReadListenerList().add(readListener);
        return self();
    }
}