-
public interface Validator
Validates bean instances. Implementations of this interface must be thread-safe.- Author:
- Emmanuel Bernard, Hardy Ferentschik, Gunnar Morling
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description ExecutableValidator
forExecutables()
Returns the contract for validating parameters and return values of methods and constructors.BeanDescriptor
getConstraintsForClass(Class<?> clazz)
Returns the descriptor object describing bean constraints.<T> T
unwrap(Class<T> type)
Returns an instance of the specified type allowing access to provider-specific APIs.<T> Set<ConstraintViolation<T>>
validate(T object, Class<?>... groups)
Validates all constraints onobject
.<T> Set<ConstraintViolation<T>>
validateProperty(T object, String propertyName, Class<?>... groups)
Validates all constraints placed on the property ofobject
namedpropertyName
.<T> Set<ConstraintViolation<T>>
validateValue(Class<T> beanType, String propertyName, Object value, Class<?>... groups)
Validates all constraints placed on the property namedpropertyName
of the classbeanType
would the property value bevalue
.
-
-
-
Method Detail
-
validate
<T> Set<ConstraintViolation<T>> validate(T object, Class<?>... groups)
Validates all constraints onobject
.- Parameters:
object
- object to validategroups
- the group or list of groups targeted for validation (defaults toDefault
)- Returns:
- constraint violations or an empty set if none
- Throws:
IllegalArgumentException
- if object isnull
or ifnull
is passed to the varargs groupsValidationException
- if a non recoverable error happens during the validation process
-
validateProperty
<T> Set<ConstraintViolation<T>> validateProperty(T object, String propertyName, Class<?>... groups)
Validates all constraints placed on the property ofobject
namedpropertyName
.- Parameters:
object
- object to validatepropertyName
- property to validate (i.e. field and getter constraints)groups
- the group or list of groups targeted for validation (defaults toDefault
)- Returns:
- constraint violations or an empty set if none
- Throws:
IllegalArgumentException
- ifobject
isnull
, ifpropertyName
isnull
, empty or not a valid object property or ifnull
is passed to the varargs groupsValidationException
- if a non recoverable error happens during the validation process
-
validateValue
<T> Set<ConstraintViolation<T>> validateValue(Class<T> beanType, String propertyName, Object value, Class<?>... groups)
Validates all constraints placed on the property namedpropertyName
of the classbeanType
would the property value bevalue
.ConstraintViolation
objects returnnull
forConstraintViolation.getRootBean()
andConstraintViolation.getLeafBean()
.- Parameters:
beanType
- the bean typepropertyName
- property to validatevalue
- property value to validategroups
- the group or list of groups targeted for validation (defaults toDefault
).- Returns:
- constraint violations or an empty set if none
- Throws:
IllegalArgumentException
- ifbeanType
isnull
, ifpropertyName
isnull
, empty or not a valid object property or ifnull
is passed to the varargs groupsValidationException
- if a non recoverable error happens during the validation process
-
getConstraintsForClass
BeanDescriptor getConstraintsForClass(Class<?> clazz)
Returns the descriptor object describing bean constraints. The returned object (and associated objects includingConstraintDescriptor
s) are immutable.- Parameters:
clazz
- class or interface type evaluated- Returns:
- the bean descriptor for the specified class
- Throws:
IllegalArgumentException
- if clazz isnull
ValidationException
- if a non recoverable error happens during the metadata discovery or if some constraints are invalid.
-
unwrap
<T> T unwrap(Class<T> type)
Returns an instance of the specified type allowing access to provider-specific APIs. If the Bean Validation provider implementation does not support the specified class,ValidationException
is thrown.- Parameters:
type
- the class of the object to be returned- Returns:
- an instance of the specified class
- Throws:
ValidationException
- if the provider does not support the call
-
forExecutables
ExecutableValidator forExecutables()
Returns the contract for validating parameters and return values of methods and constructors.- Returns:
- contract for method and constructor validation
- Since:
- 1.1
-
-
Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/validation/validator.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.