com.wujiuye.miniexcel.excel.annotation.ExcelCellTitle Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of miniexcel Show documentation

基于poi封装的一套excel文件读写工具，完美解决oom问题。优雅的使用设计模式提供更简单的使用姿势！更有详细的使用教程。如需获取帮助，关注微信公众号:Java艺术

There is a newer version: 1.4.03-RELEASE

/**
 * Copyright [2019-2020] [wujiuye]
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 

 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.wujiuye.miniexcel.excel.annotation;

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

import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 * 适用于读和写
 *
 * @author wujiuye
 * @version 1.0 on 2019/4/30 {描述：}
 */
@Target({ElementType.FIELD})
@Retention(RUNTIME)
@Documented
public @interface ExcelCellTitle {

    /**
     * -1为不参与排序
     * 用于列的排序
     *
     * @return
     */
    int cellNumber() default -1;

    /**
     * 列名，为null时，取属性的字段名
     *
     * @return
     */
    String alias() default "";

    /**
     * 是否忽略这列（这个字段）
     *
     * @return
     */
    boolean ignore() default false;

    /**
     * 日期类型格式
     * 配置优先级：
     * 注解 > 全局配置 > 框架默认
     * 当datePattern为""时，则从全局配置取，如果全局配置也没有配置，则使用框架默认的"yyyy-MM-dd HH:mm:ss"
     *
     * @return
     */
    String datePattern() default "";

    /**
     * 时区，默认东八区，0表示0时区，8表示东八区，以此类推
     * 取值范围是[-12,13]
     * 当取之超出该合法范围时，则认为没有配置时区，会从全局配置文件取，如果全局配置文件也没有，则使用框架默认的，默认为东8区
     *
     * @return
     */
    int timeZone() default Integer.MIN_VALUE;

}