com.github.ldeitos.constraint.Null Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of extendedValidation-core Show documentation

Extension for BeanValidation API Core. Content interfaces, qualifiers and constraints definitions. This version is Java 17 and JakartaEE 10 compatible.

The newest version!

package com.github.ldeitos.constraint;

import static java.lang.annotation.ElementType.ANNOTATION_TYPE;
import static java.lang.annotation.ElementType.CONSTRUCTOR;
import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.PARAMETER;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import jakarta.validation.Constraint;
import jakarta.validation.Payload;
import jakarta.validation.ReportAsSingleViolation;

/**
 * The annotated element must be {@code null}.
 * Accepts any type.
 *
 * @author Emmanuel Bernard
 */
@jakarta.validation.constraints.Null
@Target( { METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER})
@Retention(RUNTIME)
@Constraint(validatedBy = {})
@ReportAsSingleViolation()
@Documented
public @interface Null {
	String message() default "{jakarta.validation.constraints.Null.message}";
	
	/**
     * @return Parameter array to be interpolated at message. Parameters can be informed in
     * "key=value" or just "value" pattern.

     * e.g:

     * 

     * message="My {par1} message"

     * messageParameters = {"par1=parameterized"}

     * 

     * message="My {0} message"

     * messageParameters = {"parameterized"}
     */
	String[] messageParameters() default {};

    Class[] groups() default {};

    Class[] payload() default {};
    
    /**
     * Defines several {@link Null} annotations on the same element.
     *
     * @see com.github.ldeitos.constraint.Null
     */
    @Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER })
    @Retention(RUNTIME)
    @Documented
    @interface List {
        Null[] value();
    }
}