cn.gjing.tools.excel.ExcelField Maven / Gradle / Ivy
package cn.gjing.tools.excel;
import cn.gjing.tools.excel.convert.DataConvert;
import cn.gjing.tools.excel.convert.DefaultDataConvert;
import cn.gjing.tools.excel.metadata.ExcelColor;
import cn.gjing.tools.excel.read.listener.ExcelEmptyReadListener;
import cn.gjing.tools.excel.write.merge.Merge;
import java.lang.annotation.*;
/**
* This annotation is used to declare that an attribute is an Excel header,
* and if it is not annotated through this annotation,
* it will not be exported or imported as a header
*
* @author Gjing
**/
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface ExcelField {
/**
* Array of Excel header names.
* If multiple headers appear in the array and you want to merge the same header when exporting,
* you need to activate the multi-header mode before the export is executed.
* The last one in the array belongs to the real header,
* and if you are importing a multilevel header Excel file, you need to specify the real header start subscript.
* The header array size must be the same
*
* @return header names
*/
String[] value() default "";
/**
* The header above the Excel column that will be concatenated with the real header name ,
* when imported to match the header in the Excel file to an Excel column header matches the Excel column
* with the header based on the actual header name
*
* @return title
*/
String title() default "";
/**
* Column width of the excel header
*
* @return Column width
*/
int width() default 5120;
/**
* List header sort defaults to the order in which entity fields appear.
* If the current class inherits from the parent class,
* the fields of the parent class are appended to the fields of the current subclass.
* If the ORDER parameter is set, the order is sorted from smallest to largest
*
* @return sort index
*/
int order() default 0;
/**
* Cell format
* The cell format of the current column is set when exporting,
* which defaults to general，
* Some commonly used formats are {
*
* ------- @ as text
* ------- 0 as integer
* ------- 0.00 is two decimal places
* ------- yyyy-MM-dd as 年-月-日
* }
* See Excel's official cell format for more information
*
* @return format
*/
String format() default "";
/**
* Whether to enable automatic vertical merge when export
*
* @return autoMerge
*/
Merge autoMerge() default @Merge;
/**
* Is the cell content required when importing? Once set to true,
* the current row is automatically skipped when a null value is encountered.
* Of course, you can customize the processing logic by {@link ExcelEmptyReadListener} to it
*
* @return boolean
*/
boolean required() default false;
/**
* Remove white space on both sides of the string when importing
*
* @return boolean
*/
boolean trim() default false;
/**
* Data convert, which you can use to change data during import and export,
* before the cell are populated and converted to entity field
*
* @return DefaultDataConvert
* @see DataConvert
*/
Class> convert() default DefaultDataConvert.class;
/**
* Color index array, If the size of the color array is smaller than the number of series in the header,
* all subsequent headers will use the last one in the color array
*
* @return index
* @see ExcelColor
*/
ExcelColor[] color() default ExcelColor.LIME;
/**
* Font color index array, If the size of the color array is smaller than the number of series in the header,
* all subsequent headers will use the last one in the color array
*
* @return index
* @see ExcelColor
*/
ExcelColor[] fontColor() default ExcelColor.WHITE;
}