io.gitee.ludii.excel.annotation.ExcelField Maven / Gradle / Ivy

Go to download
package io.gitee.ludii.excel.annotation;

import io.gitee.ludii.excel.converts.NoneReadConverter;
import io.gitee.ludii.excel.converts.NoneWriteConverter;
import io.gitee.ludii.excel.converts.ReadConverter;
import io.gitee.ludii.excel.converts.WriteConverter;
import io.gitee.ludii.excel.enums.CellDataTypeEnum;
import io.gitee.ludii.excel.read.config.annotation.ExcelReadField;
import io.gitee.ludii.excel.write.config.annotation.ExcelWriteField;

import java.lang.annotation.*;

/**
 * @author 陆迪
 * @date 2022/4/27
 */
@Target({ElementType.FIELD, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@ExcelReadField
@ExcelWriteField
public @interface ExcelField {

    /**
     * 导入字段标题，如
     */
    String title() default "";

    /**
     * 导出字段字段排序（升序）
     */
    long sort() default 0;

    /**
     * 是否忽略此字段
     */
    boolean ignore() default false;


    /**
     * 导出字段在Excel中的数据类型
     */
    CellDataTypeEnum excelType() default CellDataTypeEnum.EMPTY;

    /**
     * 数据格式
     */
    String dataFormatPattern() default "";

    /**
     * 自定义转换方式
     */
    Class> readConverterClazz() default NoneReadConverter.class;

    /**
     * 自定义转换方式
     */
    Class> writeConverterClazz() default NoneWriteConverter.class;
}