com.alibaba.excel.converters.Converter Maven / Gradle / Ivy

Go to download

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.converters;

import com.alibaba.excel.enums.CellDataTypeEnum;
import com.alibaba.excel.metadata.CellData;
import com.alibaba.excel.metadata.GlobalConfiguration;
import com.alibaba.excel.metadata.property.ExcelContentProperty;

/**
 * Convert between Java objects and excel objects
 *
 * @author Dan Zheng
 * @param 
 */
public interface Converter {

    /**
     * Back to object types in Java
     *
     * @return Support for Java class
     */
    Class supportJavaTypeKey();

    /**
     * Back to object enum in excel
     *
     * @return Support for {@link CellDataTypeEnum}
     */
    CellDataTypeEnum supportExcelTypeKey();

    /**
     * Convert excel objects to Java objects
     *
     * @param cellData
     *            Excel cell data.NotNull.
     * @param contentProperty
     *            Content property.Nullable.
     * @param globalConfiguration
     *            Global configuration.NotNull.
     * @return Data to put into a Java object
     * @throws Exception
     *             Exception.
     */
    T convertToJavaData(CellData cellData, ExcelContentProperty contentProperty,
        GlobalConfiguration globalConfiguration) throws Exception;

    /**
     * Convert Java objects to excel objects
     *
     * @param value
     *            Java Data.NotNull.
     * @param contentProperty
     *            Content property.Nullable.
     * @param globalConfiguration
     *            Global configuration.NotNull.
     * @return Data to put into a Excel
     * @throws Exception
     *             Exception.
     */
    CellData convertToExcelData(T value, ExcelContentProperty contentProperty, GlobalConfiguration globalConfiguration)
        throws Exception;
}