com.eworkcloud.excel.annotation.ExcelProperty Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ework-cloud-starter-excel Show documentation

Ework Cloud Starter Excel

There is a newer version: 2.6.0

Show newest version

package com.eworkcloud.excel.annotation;

import com.eworkcloud.excel.enmus.ValueType;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface ExcelProperty {
    /**
     * 固定索引
     *
     * @return 索引
     */
    int index() default Integer.MAX_VALUE;

    /**
     * 列名
     *
     * @return 列名
     */
    String name();

    /**
     * 类型
     *
     * @return 类型
     */
    ValueType type() default ValueType.STRING;

    /**
     * 列宽[12]
     *
     * @return 列宽
     */
    int width() default 12;

    /**
     * 数字格式[#.##]
     * 时间格式[yyyy-MM-dd HH:mm:ss]
     *
     * @return 数字格式
     */
    String format() default "";

    /**
     * 文本后缀[%]
     *
     * @return 文本后缀
     */
    String suffix() default "";

    /**
     * 值的替换[a|id,b|id]
     *
     * @return 值的替换
     */
    String[] replace() default {};

    /**
     * 是否换行[true]
     *
     * @return 是否换行
     */
    boolean isWrap() default true;

    /**
     * 是否隐藏[false]
     *
     * @return 是否隐藏
     */
    boolean isHidden() default false;

    /**
     * 是否必须[false]
     *
     * @return 是否必须
     */
    boolean isRequired() default false;
}