cn.woodwhales.common.validation.EnumValidator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of woodwhales-common Show documentation

https://github.com/woodwhales

There is a newer version: 3.8.3

package cn.woodwhales.common.validation;

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

/**
 * 校验枚举值的校验注解
 * @author woodwhales
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD, ElementType.METHOD})
@Constraint(validatedBy = EnumValidatorValidator.class)
public @interface EnumValidator {

    /**
     * 枚举Class对象
     * @return 枚举Class对象
     */
	Class[] target() default {};

    /**
     * 枚举中要校验的数值的对应方法
     * 默认值为：Enum 类 的 name() 方法
     * @return 方法名称
     */
    String methodName() default "name";

    /**
     * 校验失败默认异常信息
     * @return 校验失败默认异常信息
     */
    String message() default "入参值不在正确枚举中";
    
    // 以下两行为固定模板
    Class[] groups() default {};
    
    Class[] payload() default {};
}