com.github.ldeitos.validation.annotation.ValidateParameters 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.validation.annotation;

import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

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

import jakarta.enterprise.util.Nonbinding;
import jakarta.interceptor.InterceptorBinding;
import jakarta.validation.groups.Default;

import com.github.ldeitos.exception.ViolationException;
import com.github.ldeitos.qualifier.Closure;
import com.github.ldeitos.validation.ValidationClosure;

/**
 * Does method parameters validation.
 *
 * @author Leandro Deitos
 *
 * @since 0.9.2
 */
@Inherited
@InterceptorBinding
@Retention(RUNTIME)
@Target({ TYPE, METHOD })
public @interface ValidateParameters {
	/**
	 * @return The group or list of groups targeted for validation (defaults to
	 *         {@link Default})
	 */
	@Nonbinding
	Class[] groups() default {};

	/**
	 * @return Closure qualifier to recover custom {@link ValidationClosure}
	 *         instance to be executed if validation process returns violations.

	 *         If not informed, default one will be used. 

	 *         Default can be configured in configuration file or, if not,
	 *         built-in component will just throw {@link ViolationException}
	 *         containing violation messages.
	 * 
	 * @see ValidationClosure
	 */
	@Nonbinding
	Closure closure() default @Closure("extededValidation.default.closure");
}