com.wuwenze.poi.annotation
注释类型 ExcelField

@Retention(value=RUNTIME)
@Target(value=FIELD)
public @interface ExcelField

作者：

wuwenze

可选元素摘要

String	comment
String	dateFormat 日期格式, 如: yyyy/MM/dd
int	maxLength
String	name 属性名, 仅在复杂数据类型时配置.
Class<? extends Options>	options
Class<? extends ReadConverter>	readConverter 读取内容转换器, 与 readConverterExp 二选一(优先级1)
String	readConverterExp 读取内容转表达式 (如: 男=1,女=2), 与 readConverter 二选一(优先级0)
String	regularExp 正则表达式, 读取时生效, 与 validator 二选一(优先级0)
String	regularExpMessage 正则表达式验证失败时的错误消息, regularExp 配置后生效
boolean	required
Class<? extends Validator>	validator 自定义验证器, 读取时生效, 与 regularExp 二选一(优先级1)
String	value
short	width
Class<? extends WriteConverter>	writeConverter 写入内容转换器, 与 writeConverterExp 二选一(优先级1)
String	writeConverterExp 写入内容转换表达式 (如: 1=男,2=女), 与 writeConverter 二选一(优先级0)

value

public abstract String value

返回：

单元格名称(如 : id字段显示为 ' 编号 ') 默认为字段名

默认值：

""

name

public abstract String name

属性名, 仅在复杂数据类型时配置.

   (At)ExcelField(name="user.name");
   private User user;
 

返回：

属性名

默认值：

""

width

public abstract short width

返回：

单元格宽度[仅限表头] 默认-1(自动计算列宽)

默认值：

-1

required

public abstract boolean required

返回：

是否必填

默认值：

false

comment

public abstract String comment

返回：

批注信息, 生成模板时生效

默认值：

""

maxLength

public abstract int maxLength

返回：

最大长度, 读取时生效, 默认不限制

默认值：

-1

dateFormat

public abstract String dateFormat

日期格式, 如: yyyy/MM/dd

返回：

日期格式

默认值：

""

options

public abstract Class<? extends Options> options

返回：

下拉框数据源, 生成模板和验证数据时生效

默认值：

com.wuwenze.poi.annotation.ExcelField.Void.class

writeConverterExp

public abstract String writeConverterExp

写入内容转换表达式 (如: 1=男,2=女), 与 writeConverter 二选一(优先级0)

返回：

写入内容转换表达式

另请参见：

writeConverter()

默认值：

""

writeConverter

public abstract Class<? extends WriteConverter> writeConverter

写入内容转换器, 与 writeConverterExp 二选一(优先级1)

返回：

写入内容转换器

另请参见：

writeConverterExp()

默认值：

com.wuwenze.poi.annotation.ExcelField.Void.class

readConverterExp

public abstract String readConverterExp

读取内容转表达式 (如: 男=1,女=2), 与 readConverter 二选一(优先级0)

返回：

读取内容转表达式

另请参见：

readConverter()

默认值：

""

readConverter

public abstract Class<? extends ReadConverter> readConverter

读取内容转换器, 与 readConverterExp 二选一(优先级1)

返回：

读取内容转换器

另请参见：

readConverterExp()

默认值：

com.wuwenze.poi.annotation.ExcelField.Void.class

regularExp

public abstract String regularExp

正则表达式, 读取时生效, 与 validator 二选一(优先级0)

返回：

正则表达式

另请参见：

validator()

默认值：

""

regularExpMessage

public abstract String regularExpMessage

正则表达式验证失败时的错误消息, regularExp 配置后生效

返回：

正则表达式验证失败时的错误消息

另请参见：

regularExp()

默认值：

""

validator

public abstract Class<? extends Validator> validator

自定义验证器, 读取时生效, 与 regularExp 二选一(优先级1)

返回：

自定义验证器

另请参见：

regularExp()

默认值：

com.wuwenze.poi.annotation.ExcelField.Void.class