javax.validation.spi
Interface ValidationProvider

public interface ValidationProvider

Contract between the validation bootstrap mechanism and the provider engine.

Implementations must have a public no-arg constructor. The construction of a provider should be as "lightweight" as possible.

Author:

Emmanuel Bernard, Hardy Ferentschik

Method Summary

ValidatorFactory	buildValidatorFactory(ConfigurationState configurationState) Build a ValidatorFactory using the current provider implementation.
Configuration<?>	createGenericConfiguration(BootstrapState state) Returns a Configuration instance.
<T extends Configuration<T>> T	createSpecializedConfiguration(BootstrapState state, java.lang.Class<T> configurationClass) Returns a Configuration instance implementing the configurationClass interface.
boolean	isSuitable(java.lang.Class<? extends Configuration<?>> configurationClass) Return true if configurationClass is the uniquely identifying Configuration subclass for this provider

Method Detail

isSuitable

boolean isSuitable(java.lang.Class<? extends Configuration<?>> configurationClass)

Return true if configurationClass is the uniquely identifying Configuration subclass for this provider

Parameters:

configurationClass - targeted configuration class.

Returns:

true if configurationClass is the Bean Validation Provider sub-interface for Configuration

createSpecializedConfiguration

<T extends Configuration<T>> T createSpecializedConfiguration(BootstrapState state,
                                                              java.lang.Class<T> configurationClass)

Returns a Configuration instance implementing the configurationClass interface. The returned Configuration instance must use the current provider (this) to build the ValidatorFactory instance.

This method can only be called on providers returning true on #isSuitable(configurationClass)

Parameters:

configurationClass - the Configuration class type

state - bootstrap state

Returns:

specific Configuration implementation

createGenericConfiguration

Configuration<?> createGenericConfiguration(BootstrapState state)

Returns a Configuration instance. This instance is not bound to use the current provider. The choice of provider follows the algorithm described in Configuration

The ValidationProviderResolver used by Configuration is provided by state. If null, the default ValidationProviderResolver is used.

Parameters:

state - bootstrap state

Returns:

Non specialized Configuration implementation

buildValidatorFactory

ValidatorFactory buildValidatorFactory(ConfigurationState configurationState)

Build a ValidatorFactory using the current provider implementation. The ValidatorFactory is assembled and follows the configuration passed via ConfigurationState.

The returned ValidatorFactory is properly initialized and ready for use.

Parameters:

configurationState - the configuration descriptor

Returns:

the instanciated ValidatorFactory

Throws:

ValidationException - if the ValidatorFactory cannot be built