com.moon.validator.annotation.InInts Maven / Gradle / Ivy
package com.moon.validator.annotation;
import com.moon.validator.impl.InIntsValidator;
import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* 限制输入的 int 型数字，只能使用在{@link Integer}或{@code int}字段上
*
* 默认允许 null 值（当字段类型是{@link Integer}时）
*
* 可指定{@link #nullable()}=true 要求不能为 null，或使用{@link javax.validation.constraints.NotNull}
*
* 如要求 int 值在：1, 2, 3 中
*
* @InInts(values = "1,2,3")
* private int value;
*
*
* 默认允许 null 值
*
* @author moonsky
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD, ElementType.PARAMETER})
@Constraint(validatedBy = InIntsValidator.class)
public @interface InInts {
/**
* 字段是否允许为 null 值
*
* @return 等于 false 且字段类型是{@link Integer}时，字段不能为 null
*/
boolean nullable() default true;
/**
* int 值列表，多个值用逗号隔开
*
* @return int 值，如："1, 2, 3, 4, 5"；间隔符之间的空格会自动忽略
*/
String values() default "";
/**
* 错误消息提示模板
*
* @return {@link Message#AT_ALL}
*/
String message() default "必须是数值 [{values}] 之一";
/**
* 分组验证
*
* @return 分组对不同场景下使用不同的验证规则
*/
Class[] groups() default {};
Class[] payload() default {};
}