javax.validation.bootstrap.GenericBootstrap Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of validation-api Show documentation

Bean Validation (JSR-303) API.

There is a newer version: 2.0.1.Final

package javax.validation.bootstrap;

import javax.validation.ValidationProviderResolver;
import javax.validation.Configuration;

/**
 * Defines the state used to bootstrap Bean Validation and
 * creates a provider agnostic Configuration.
 *
 * @author Emmanuel Bernard
 */
public interface GenericBootstrap {
	/**
	 * Defines the provider resolution strategy.
	 * This resolver returns the list of providers evaluated
	 * to build the Configuration
	 * 
	 * If no resolver is defined, the default ValidationProviderResolver
	 * implementation is used.
	 *
	 * @return this following the chaining method pattern
	 */
	GenericBootstrap providerResolver(ValidationProviderResolver resolver);

	/**
	 * Returns a generic Configuration implementation.
	 * At this stage the provider used to build the ValidatorFactory is not defined.
	 * 
	 * The Configuration implementation is provided by the first provider returned
	 * by the ValidationProviderResolver strategy.
	 *
	 * @return a Configuration implementation compliant with the bootstrap state
	 * @throws javax.validation.ValidationException if the Configuration object cannot be built
	 *                        this is generally due to an issue with the ValidationProviderResolver
	 */
	Configuration configure();
}