com.kangaroohy.plugin.excel.annotation.ResponseExcel Maven / Gradle / Ivy
package com.kangaroohy.plugin.excel.annotation;
import com.alibaba.excel.converters.Converter;
import com.alibaba.excel.support.ExcelTypeEnum;
import com.alibaba.excel.write.handler.WriteHandler;
import com.kangaroohy.plugin.excel.head.HeadGenerator;
import java.lang.annotation.*;
/**
* `@ResponseExcel 注解`
*
* @author kangaroohy
*/
@Documented
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface ResponseExcel {
/**
* 文件名称
* @return string
*/
String name() default "";
/**
* 文件类型 （xlsx xls）
* @return string
*/
ExcelTypeEnum suffix() default ExcelTypeEnum.XLSX;
/**
* 文件密码
* @return password
*/
String password() default "";
/**
* sheet 名称，支持多个
* @return String[]
*/
Sheet[] sheets() default {};
/**
* 内存操作
* @return
*/
boolean inMemory() default false;
/**
* excel 模板
* @return String
*/
String template() default "";
/**
* + 包含字段
* @return String[]
*/
String[] include() default {};
/**
* 排除字段
* @return String[]
*/
String[] exclude() default {};
/**
* 拦截器，自定义样式等处理器
* @return WriteHandler[]
*/
Class[] writeHandler() default {};
/**
* 转换器
* @return Converter[]
*/
Class[] converter() default {};
/**
* 自定义Excel头生成器
* @return HeadGenerator
*/
Class headGenerator() default HeadGenerator.class;
/**
* excel 头信息国际化
* @return boolean
*/
boolean i18nHeader() default false;
/**
* 填充模式
* @return
*/
boolean fill() default false;
}