top.cutexingluo.tools.common.valid.num.longstatus.LongStatus Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xingtools-pkg-jdk8 Show documentation

xingtools 依赖core包，jdk 分类包，对不同的jdk版本提供兼容性

The newest version!

package top.cutexingluo.tools.common.valid.num.longstatus;

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.*;

/**
 * Long 验证器
 *
 * 需要导入 spring-boot-starter-validation 包
 * 
 *     执行顺序
 *     是否notNull，未设置则 null 会通过，建议@NotNull
 *     先进行数字精确匹配 matchNum
 *     再进行数字范围模糊匹配 limit
 * 
 *
 * @author XingTian
 * @version 1.0.0
 * @date 2023/12/8 16:12
 * @since 1.0.3
 */
@Documented
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD, ElementType.PARAMETER})
@Constraint(validatedBy = {LongStatusValidator.class})
public @interface LongStatus {


    /**
     * 1.是否非空 null
     * 也可以使用 @NotNull 注解
     * 不设置这个，如果为null则会通过
     *
     * @return boolean
     */
    boolean notNull() default false;


    /**
     * 2.只要目标满足指定数字即可通过,无视大小限制
     *
     * @return {@link long[]}
     */
    long[] matchNum() default {};


    /**
     * 3.是否限制大小
     *
     * @return boolean
     */
    boolean limit() default false;

    /**
     * lenLimit开启

     * 3.最小长度
     *
     * @return long
     */
    long min() default 0;

    /**
     * lenLimit开启

     * 3.最大长度
     *
     * @return long
     */
    long max() default Integer.MAX_VALUE;


    /**
     * 4.范围限制
     * 如果设置了range，则判定是否在此范围内, [ inclusive, inclusive] 
     * 可以设置多个
     *
     * @return {@link LongRange[]}
     * @since 1.0.3
     */
    LongRange[] range() default {};


    /**
     * 不满足返回的消息
     *
     * @return {@link String}
     */
    String message() default "The transfer data is in the wrong format";


    /**
     * 分组
     *
     * @return {@link Class}<{@link ?}>{@link []}
     */
    Class[] groups() default {};

    Class[] payload() default {};
}