All Downloads are FREE. Search and download functionalities are using the official Maven repository.

javax.validation.spi.ValidationProvider Maven / Gradle / Ivy

There is a newer version: 2.0.1.Final
Show newest version
// $Id: ValidationProvider.java 16161 2009-03-16 23:26:39Z epbernard $
/*
* JBoss, Home of Professional Open Source
* Copyright 2008, Red Hat Middleware LLC, 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.spi;

import javax.validation.Configuration;
import javax.validation.ValidatorFactory;

/**
 * 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 * @author Hardy Ferentschik */ public interface ValidationProvider { /** * Return true if configurationClass is the uniquely identifying * Configuration subclass for this provider * * @param configurationClass targeted configuration class. * * @return true if configurationClass is the Bean Validation Provider * sub-interface for Configuration */ boolean isSuitable(Class> 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) * * @param configurationClass the Configuration class type * @param state bootstrap state * * @return specific Configuration implementation */ > T createSpecializedConfiguration( BootstrapState state, Class configurationClass); /** * Returns a Configuration instance. This instance is not bound to * use the current provider. The choice of provider follows the algorithm described * in {@link javax.validation.Configuration} *

* The ValidationProviderResolver used by Configuration * is provided by state. * If null, the default ValidationProviderResolver is used. * * @param state bootstrap state * * @return Non specialized Configuration implementation */ Configuration createGenericConfiguration(BootstrapState state); /** * 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. *

* * @param configurationState the configuration descriptor * * @return the instanciated ValidatorFactory * @throws javax.validation.ValidationException if the ValidatorFactory cannot be built */ ValidatorFactory buildValidatorFactory(ConfigurationState configurationState); }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy