com.alibaba.excel.annotation

Annotation Type ExcelProperty

@Target(value=FIELD)
 @Retention(value=RUNTIME)
 @Inherited
public @interface ExcelProperty

Author:

jipengfei

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<? extends Converter<?>>	converter Force the current field to use this converter.
String	format Deprecated. please use DateTimeFormat
int	index Index of column Read or write it on the index of column, If it's equal to -1, it's sorted by Java class.
int	order Defines the sort order for an column.
String[]	value The name of the sheet header.

Element Detail

value

public abstract String[] value

The name of the sheet header.

write: It automatically merges when you have more than one head

read: When you have multiple heads, take the last one

Returns:

The name of the sheet header

Default:

""

index

public abstract int index

Index of column Read or write it on the index of column, If it's equal to -1, it's sorted by Java class. priority: index > order > default sort

Returns:

Index of column

Default:

-1

order

public abstract int order

Defines the sort order for an column. priority: index > order > default sort

Returns:

Order of column

Default:

2147483647

converter

public abstract Class<? extends Converter<?>> converter

Force the current field to use this converter.

Returns:

Converter

Default:

com.alibaba.excel.converters.AutoConverter.class

format

@Deprecated
public abstract String format

Deprecated. please use DateTimeFormat

default @see com.alibaba.excel.util.TypeUtil if default is not meet you can set format

Returns:

Format string

Default:

""