com.github.hugh.annotation.constraints.IpV4 Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of toolbox Show documentation

The newest version!

package com.github.hugh.annotation.constraints;

import com.github.hugh.annotation.constraints.validator.IpV4Validator;

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 * IpV4 校验注解
 *
 * @author hugh
 * @since 1.4.9
 */
@Documented
@Retention(RUNTIME)
@Target({METHOD, FIELD, PARAMETER})
@Constraint(validatedBy = IpV4Validator.class)//指向自定义验证类
public @interface IpV4 {

    /**
     * 返回信息
     *
     * @return String
     */
    String message() default "IP格式错误"; //这边可以标注默认的验证失败消息

    /**
     * 值
     *
     * @return String
     */
    String value() default "";

    /**
     * 是否允许为空
     * 默认不允许，也就是false时，不管value是空字符串或者null都进行Ip规则校验
     *
     * @return boolean
     */
    boolean nullable() default false;

    Class[] groups() default {};

    Class[] payload() default {};
}