Package jakarta.validation
Class Validation
- java.lang.Object
-
- jakarta.validation.Validation
-
public class Validation extends Object
This class is the entry point for Jakarta Bean Validation.There are three ways to bootstrap it:
- The easiest approach is to build the default
ValidatorFactory
.ValidatorFactory factory = Validation.buildDefaultValidatorFactory();
In this case, the default validation provider resolver will be used to locate available providers.The chosen provider is defined as followed:
- if the XML configuration defines a provider, this provider is used
- if the XML configuration does not define a provider or if no XML
configuration is present the first provider returned by the
ValidationProviderResolver
instance is used.
-
The second bootstrap approach allows to choose a custom
ValidationProviderResolver
. The chosenValidationProvider
is then determined in the same way as in the default bootstrapping case (see above).Configuration<?> configuration = Validation .byDefaultProvider() .providerResolver( new MyResolverStrategy() ) .configure(); ValidatorFactory factory = configuration.buildValidatorFactory();
-
The third approach allows you to specify explicitly and in
a type safe fashion the expected provider.
Optionally you can choose a custom
ValidationProviderResolver
.ACMEConfiguration configuration = Validation .byProvider(ACMEProvider.class) .providerResolver( new MyResolverStrategy() ) // optionally set the provider resolver .configure(); ValidatorFactory factory = configuration.buildValidatorFactory();
Note:
-
The
ValidatorFactory
object built by the bootstrap process should be cached and shared amongstValidator
consumers. - This class is thread-safe.
- Author:
- Emmanuel Bernard, Hardy Ferentschik
- The easiest approach is to build the default
-
-
Constructor Summary
Constructors Constructor Description Validation()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static ValidatorFactory
buildDefaultValidatorFactory()
Builds and returns aValidatorFactory
instance based on the default Jakarta Bean Validation provider and following the XML configuration.static GenericBootstrap
byDefaultProvider()
Builds aConfiguration
.static <T extends Configuration<T>,U extends ValidationProvider<T>>
ProviderSpecificBootstrap<T>byProvider(Class<U> providerType)
Builds aConfiguration
for a particular provider implementation.
-
-
-
Method Detail
-
buildDefaultValidatorFactory
public static ValidatorFactory buildDefaultValidatorFactory()
Builds and returns aValidatorFactory
instance based on the default Jakarta Bean Validation provider and following the XML configuration.The provider list is resolved using the default validation provider resolver logic.
The code is semantically equivalent to
Validation.byDefaultProvider().configure().buildValidatorFactory()
.- Returns:
ValidatorFactory
instance- Throws:
NoProviderFoundException
- if no Jakarta Bean Validation provider was foundValidationException
- if a Jakarta Bean Validation provider was found but theValidatorFactory
cannot be built
-
byDefaultProvider
public static GenericBootstrap byDefaultProvider()
Builds aConfiguration
. The provider list is resolved using the strategy provided to the bootstrap state.Configuration<?> configuration = Validation .byDefaultProvider() .providerResolver( new MyResolverStrategy() ) .configure(); ValidatorFactory factory = configuration.buildValidatorFactory();
The provider can be specified in the XML configuration. If the XML configuration does not exist or if no provider is specified, the first available provider will be returned.- Returns:
- instance building a generic
Configuration
compliant with the bootstrap state provided
-
byProvider
public static <T extends Configuration<T>,U extends ValidationProvider<T>> ProviderSpecificBootstrap<T> byProvider(Class<U> providerType)
Builds aConfiguration
for a particular provider implementation.Optionally overrides the provider resolution strategy used to determine the provider.
Used by applications targeting a specific provider programmatically.
ACMEConfiguration configuration = Validation.byProvider(ACMEProvider.class) .providerResolver( new MyResolverStrategy() ) .configure();
, whereACMEConfiguration
is theConfiguration
sub interface uniquely identifying the ACME Jakarta Bean Validation provider. andACMEProvider
is theValidationProvider
implementation of the ACME provider.- Type Parameters:
T
- the type of theConfiguration
corresponding to thisValidationProvider
U
- the type of theValidationProvider
implementation- Parameters:
providerType
- theValidationProvider
implementation type- Returns:
- instance building a provider specific
Configuration
sub interface implementation
-
-