com.houkunlin.system.dict.starter.json.Array Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of system-dict-starter Show documentation

系统数据字典自动翻译成字典文本。可集合系统数据库中存储的用户数据字典，也可使用枚举做系统数据字典，主要用在返回数据给前端时自动把字典值翻译成字典文本信息； The system data dictionary is automatically translated into dictionary text. The user data dictionary stored in the system database can be aggregated, and the enumeration can also be used as the system data dictionary. It is mainly used to automatically translate dictionary values into dictionary text information when returning data to the front end.

The newest version!

package com.houkunlin.system.dict.starter.json;

import java.lang.annotation.*;

/**
 * 字典字段的字符串分隔
 *
 * @author HouKunLin
 * @since 1.4.3
 */
@Target({ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Array {
    /**
     * 是否分隔字段值来转换字典。此值只对字段为字符串类型的生效，当此值为 空字符串 的时候不生效（即字符串不分割）
     *
     * @return 分隔符
     */
    String split() default ",";

    /**
     * 是否转换为字符串显示。true：字符串显示。false：数组显示
     *
     * @return 是否转换为数组显示
     */
    boolean toText() default true;

    /**
     * 此参数仅当 {@link #toText()} 设置为 true 时有效（使用字符串显示），此参数将用作每个字典文本值之间的分隔符
     *
     * @return 字符串分隔符
     */
    String joinSeparator() default "、";

    /**
     * 是否忽略字典文本为 null 的数据。true：忽略，跳过；false：不忽略，输出 'null' 字符串
     *
     * @return 是否忽略字典文本为 null 的数据
     */
    boolean ignoreNull() default true;
}