javax.validation.bootstrap.GenericBootstrap Maven / Gradle / Ivy
/*
* JBoss, Home of Professional Open Source
* Copyright 2009, Red Hat, Inc. and/or its affiliates, and individual contributors
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package javax.validation.bootstrap;
import javax.validation.Configuration;
import javax.validation.ValidationException;
import javax.validation.ValidationProviderResolver;
import javax.validation.ValidatorFactory;
/**
* Defines the state used to bootstrap Bean Validation and
* creates a provider agnostic {@link Configuration}.
*
* @author Emmanuel Bernard
*/
public interface GenericBootstrap {
/**
* Defines the provider resolution strategy.
* This resolver returns the list of providers evaluated
* to build the {@link Configuration}.
*
* If no resolver is defined, the default {@link ValidationProviderResolver}
* implementation is used.
*
* @param resolver the {@code ValidationProviderResolver} to use for bootstrapping
* @return {@code this} following the chaining method pattern
*/
GenericBootstrap providerResolver(ValidationProviderResolver resolver);
/**
* Returns a generic {@link Configuration} implementation.
* At this stage the provider used to build the {@link ValidatorFactory}
* is not defined.
*
* The {@code Configuration} implementation is provided by the first provider
* returned by the {@link ValidationProviderResolver} strategy.
*
* @return a {@code Configuration} implementation compliant with the bootstrap state
* @throws ValidationException if the {@code Configuration} object cannot be built;
* this is generally due to an issue with the {@code ValidationProviderResolver}
*/
Configuration configure();
}