/*
* Jakarta Bean Validation API
*
* License: Apache License, Version 2.0
* See the license.txt file in the root directory or <http://www.apache.org/licenses/LICENSE-2.0>.
*/
package javax.validation.executable;
import java.lang.reflect.Constructor;
import java.lang.reflect.Method;
import java.util.Set;
import javax.validation.ConstraintViolation;
import javax.validation.ValidationException;
import javax.validation.groups.Default;
Validates parameters and return values of methods and constructors.
Implementations of this interface must be thread-safe.
Author: Gunnar Morling Since: 1.1
/**
* Validates parameters and return values of methods and constructors.
* Implementations of this interface must be thread-safe.
*
* @author Gunnar Morling
* @since 1.1
*/
public interface ExecutableValidator {
Validates all constraints placed on the parameters of the given method.
Params: - object – the object on which the method to validate is invoked
- method – the method for which the parameter constraints is validated
- parameterValues – the values provided by the caller for the given method's
parameters
- groups – the group or list of groups targeted for validation (defaults to
Default
)
Type parameters: - <T> – the type hosting the method to validate
Throws: - IllegalArgumentException – if
null
is passed for any of the parameters or if parameters don't match with each other - ValidationException – if a non recoverable error happens during the
validation process
Returns: a set with the constraint violations caused by this validation; will be empty if no error occurs, but never null
/**
* Validates all constraints placed on the parameters of the given method.
*
* @param <T> the type hosting the method to validate
* @param object the object on which the method to validate is invoked
* @param method the method for which the parameter constraints is validated
* @param parameterValues the values provided by the caller for the given method's
* parameters
* @param groups the group or list of groups targeted for validation (defaults to
* {@link Default})
* @return a set with the constraint violations caused by this validation;
* will be empty if no error occurs, but never {@code null}
* @throws IllegalArgumentException if {@code null} is passed for any of the parameters
* or if parameters don't match with each other
* @throws ValidationException if a non recoverable error happens during the
* validation process
*/
<T> Set<ConstraintViolation<T>> validateParameters(T object,
Method method,
Object[] parameterValues,
Class<?>... groups);
Validates all return value constraints of the given method.
Params: - object – the object on which the method to validate is invoked
- method – the method for which the return value constraints is validated
- returnValue – the value returned by the given method
- groups – the group or list of groups targeted for validation (defaults to
Default
)
Type parameters: - <T> – the type hosting the method to validate
Throws: - IllegalArgumentException – if
null
is passed for any of the object, method or groups parameters or if parameters don't match with each other - ValidationException – if a non recoverable error happens during the
validation process
Returns: a set with the constraint violations caused by this validation; will be empty if no error occurs, but never null
/**
* Validates all return value constraints of the given method.
*
* @param <T> the type hosting the method to validate
* @param object the object on which the method to validate is invoked
* @param method the method for which the return value constraints is validated
* @param returnValue the value returned by the given method
* @param groups the group or list of groups targeted for validation (defaults to
* {@link Default})
* @return a set with the constraint violations caused by this validation;
* will be empty if no error occurs, but never {@code null}
* @throws IllegalArgumentException if {@code null} is passed for any of the object,
* method or groups parameters or if parameters don't match with each other
* @throws ValidationException if a non recoverable error happens during the
* validation process
*/
<T> Set<ConstraintViolation<T>> validateReturnValue(T object,
Method method,
Object returnValue,
Class<?>... groups);
Validates all constraints placed on the parameters of the given constructor.
Params: - constructor – the constructor for which the parameter constraints is validated
- parameterValues – the values provided by the caller for the given constructor's
parameters
- groups – the group or list of groups targeted for validation (defaults to
Default
)
Type parameters: - <T> – the type hosting the constructor to validate
Throws: - IllegalArgumentException – if
null
is passed for any of the parameters or if parameters don't match with each other - ValidationException – if a non recoverable error happens during the
validation process
Returns: a set with the constraint violations caused by this validation; Will be empty if no error occurs, but never null
/**
* Validates all constraints placed on the parameters of the given constructor.
*
* @param <T> the type hosting the constructor to validate
* @param constructor the constructor for which the parameter constraints is validated
* @param parameterValues the values provided by the caller for the given constructor's
* parameters
* @param groups the group or list of groups targeted for validation (defaults to
* {@link Default})
* @return a set with the constraint violations caused by this validation;
* Will be empty if no error occurs, but never {@code null}
* @throws IllegalArgumentException if {@code null} is passed for any of the parameters
* or if parameters don't match with each other
* @throws ValidationException if a non recoverable error happens during the
* validation process
*/
<T> Set<ConstraintViolation<T>> validateConstructorParameters(Constructor<? extends T> constructor,
Object[] parameterValues,
Class<?>... groups);
Validates all return value constraints of the given constructor.
Params: - constructor – the constructor for which the return value constraints is validated
- createdObject – the object instantiated by the given method
- groups – the group or list of groups targeted for validation (defaults to
Default
)
Type parameters: - <T> – the type hosting the constructor to validate
Throws: - IllegalArgumentException – if
null
is passed for any of the parameters or if parameters don't match with each other - ValidationException – if a non recoverable error happens during the
validation process
Returns: a set with the constraint violations caused by this validation; will be empty, if no error occurs, but never null
/**
* Validates all return value constraints of the given constructor.
*
* @param <T> the type hosting the constructor to validate
* @param constructor the constructor for which the return value constraints is validated
* @param createdObject the object instantiated by the given method
* @param groups the group or list of groups targeted for validation (defaults to
* {@link Default})
* @return a set with the constraint violations caused by this validation;
* will be empty, if no error occurs, but never {@code null}
* @throws IllegalArgumentException if {@code null} is passed for any of the parameters
* or if parameters don't match with each other
* @throws ValidationException if a non recoverable error happens during the
* validation process
*/
<T> Set<ConstraintViolation<T>> validateConstructorReturnValue(Constructor<? extends T> constructor,
T createdObject,
Class<?>... groups);
}