com.viiyue.plugins.excel.annotation.ExcelCell Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of poi-lite Show documentation
Simple Excel toolkit
There is a newer version: 1.1.2
/**
 * Copyright (C) 2021 the original author or authors.
 *
 * 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.viiyue.plugins.excel.annotation;

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

import com.viiyue.plugins.excel.converter.DefaultReadConverter;
import com.viiyue.plugins.excel.converter.ReadConverter;
import com.viiyue.plugins.excel.converter.Styleable;
import com.viiyue.plugins.excel.converter.WriteConverter;

/**
 * Excel cell metadata descriptor
 *
 * @author tangxbai
 * @since 2023/06/19
 */
@Documented
@Target( { ElementType.FIELD, ElementType.METHOD } )
@Retention( RetentionPolicy.RUNTIME )
public @interface ExcelCell {

    /**
     * Sse field name by default
     * 
     * @return the header cell
     */
    String label();

    /**
     * Whether to ignore this content during write operation
     * 
     * @return ignore status
     */
    boolean ignoreHeader() default false;

    /**
     * 
     * Set the cell width, the unit is the number of characters.
     * 
     * 

     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * TEXT WIDTH
测试文字 4
Test words 10
     * 
     * @return the excel cell width
     */
    int width() default 0;

    boolean widthAutoSize() default false;

    /**
     * The time format pattern of Date, LocalDate and LocalDateTime.
     * 
     * @return date format pattern
     */
    String dateformat() default "yyyy-MM-dd HH:mm:ss";

    /**
     * @return boolean replacement value, fill in the order of true/false.
     */
    String [] bools() default {};

    /**
     * Cell style
     * 
     * @return the class of the {@link Styleable}
     */
    @SuppressWarnings( "rawtypes" )
    Class styleable() default Styleable.class;

    /**
     * Custom cell write converter
     * 
     * @return the {@link WriteConverter} class
     */
    Class writer() default WriteConverter.class;

    /**
     * Custom cell read converter
     * 
     * @return the {@link ReadConverter} class
     */
    Class reader() default DefaultReadConverter.class;

}