ConfigurationImpl (JBoss Application Server: Build 7.1.2.Final API)

java.lang.Object
- org.hibernate.validator.engine.ConfigurationImpl

All Implemented Interfaces:

Configuration<HibernateValidatorConfiguration>, ConfigurationState, HibernateValidatorConfiguration
```
public class ConfigurationImpl
extends Object
implements HibernateValidatorConfiguration, ConfigurationState
```
Hibernate specific Configuration implementation.

Author:

Emmanuel Bernard, Hardy Ferentschik, Gunnar Morling, Kevin Pollet - SERLI - (kevin.pollet@serli.com)

Field Summary
- Fields inherited from interface org.hibernate.validator.HibernateValidatorConfiguration
  FAIL_FAST

Constructor Summary

Constructors
Constructor and Description

ConfigurationImpl(BootstrapState state)

ConfigurationImpl(ValidationProvider<?> provider)

Constructors
Constructor and Description
`ConfigurationImpl(BootstrapState state)`
`ConfigurationImpl(ValidationProvider<?> provider)`

Method Summary

Methods
Modifier and Type	Method and Description
`HibernateValidatorConfiguration`	`addMapping(ConstraintMapping mapping)` Adds the specified `ConstraintMapping` instance to the configuration.
`HibernateValidatorConfiguration`	`addMapping(InputStream stream)` Add a stream describing constraint mapping in the Bean Validation XML format.
`HibernateValidatorConfiguration`	`addProperty(String name, String value)` Add a provider specific property.
`ValidatorFactory`	`buildValidatorFactory()` Build a `ValidatorFactory` implementation.
`ConfigurationImpl`	`constraintValidatorFactory(ConstraintValidatorFactory constraintValidatorFactory)` Defines the constraint validator factory.
`HibernateValidatorConfiguration`	`failFast(boolean failFast)` En- or disables the fail fast mode.
`ConstraintValidatorFactory`	`getConstraintValidatorFactory()` Returns the constraint validator factory of this configuration.
`ConstraintValidatorFactory`	`getDefaultConstraintValidatorFactory()` Return an implementation of the `ConstraintValidatorFactory` interface following the default `ConstraintValidatorFactory` defined in the specification: uses the public no-arg constructor of the `ConstraintValidator`
`MessageInterpolator`	`getDefaultMessageInterpolator()` Return an implementation of the `MessageInterpolator` interface following the default `MessageInterpolator` defined in the specification: use the ValidationMessages resource bundle to load keys use Locale.getDefault()
`ResourceBundleLocator`	`getDefaultResourceBundleLocator()` Returns the `ResourceBundleLocator` used by the `default message interpolator` to load user-provided resource bundles.
`TraversableResolver`	`getDefaultTraversableResolver()` Return an implementation of the `TraversableResolver` interface following the default `TraversableResolver` defined in the specification: if Java Persistence is available in the runtime environment, a property is considered reachable if Java Persistence considers the property as loaded if Java Persistence is not available in the runtime environment, all properties are considered reachable all properties are considered cascadable.
`boolean`	`getFailFast()`
`ConstraintMapping`	`getMapping()`
`Set<InputStream>`	`getMappingStreams()` Returns a set of configuration streams.
`MessageInterpolator`	`getMessageInterpolator()` Returns the message interpolator of this configuration.
`Map<String,String>`	`getProperties()` Returns a map of non type-safe custom properties.
`TraversableResolver`	`getTraversableResolver()` Returns the traversable resolver for this configuration.
`HibernateValidatorConfiguration`	`ignoreXmlConfiguration()` Ignore data from the META-INF/validation.xml file if this method is called.
`boolean`	`isIgnoreXmlConfiguration()` Returns true if Configuration.ignoreXMLConfiguration() has been called In this case, the ValidatorFactory must ignore META-INF/validation.xml
`ConfigurationImpl`	`messageInterpolator(MessageInterpolator interpolator)` Defines the message interpolator used.
`ConfigurationImpl`	`traversableResolver(TraversableResolver resolver)` Defines the traversable resolver used.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ConfigurationImpl
```
public ConfigurationImpl(BootstrapState state)
```
  - ConfigurationImpl
```
public ConfigurationImpl(ValidationProvider<?> provider)
```
- Method Detail
  - ignoreXmlConfiguration
```
public final HibernateValidatorConfiguration ignoreXmlConfiguration()
```
    Description copied from interface: Configuration
    
    Ignore data from the META-INF/validation.xml file if this method is called. This method is typically useful for containers that parse META-INF/validation.xml themselves and pass the information via the Configuration methods.
    
    Specified by:
    
    ignoreXmlConfiguration in interface Configuration<HibernateValidatorConfiguration>
    
    Returns:
    this following the chaining method pattern.
  - messageInterpolator
```
public final ConfigurationImpl messageInterpolator(MessageInterpolator interpolator)
```
    Description copied from interface: Configuration
    
    Defines the message interpolator used. Has priority over the configuration based message interpolator. If null is passed, the default message interpolator is used (defined in XML or the specification default).
    
    Specified by:
    
    messageInterpolator in interface Configuration<HibernateValidatorConfiguration>
    
    Parameters:
    interpolator - message interpolator implementation.
    
    Returns:
    this following the chaining method pattern.
  - traversableResolver
```
public final ConfigurationImpl traversableResolver(TraversableResolver resolver)
```
    Description copied from interface: Configuration
    
    Defines the traversable resolver used. Has priority over the configuration based traversable resolver. If null is passed, the default traversable resolver is used (defined in XML or the specification default).
    
    Specified by:
    
    traversableResolver in interface Configuration<HibernateValidatorConfiguration>
    
    Parameters:
    resolver - traversable resolver implementation.
    
    Returns:
    this following the chaining method pattern.
  - constraintValidatorFactory
```
public final ConfigurationImpl constraintValidatorFactory(ConstraintValidatorFactory constraintValidatorFactory)
```
    Description copied from interface: Configuration
    
    Defines the constraint validator factory. Has priority over the configuration based constraint factory. If null is passed, the default constraint validator factory is used (defined in XML or the specification default).
    
    Specified by:
    
    constraintValidatorFactory in interface Configuration<HibernateValidatorConfiguration>
    
    Parameters:
    constraintValidatorFactory - constraint factory inmplementation.
    
    Returns:
    this following the chaining method pattern.
  - addMapping
```
public final HibernateValidatorConfiguration addMapping(InputStream stream)
```
    Description copied from interface: Configuration
    
    Add a stream describing constraint mapping in the Bean Validation XML format.
    The stream should be closed by the client API after the ValidatorFactory has been built. The Bean Validation provider must not close the stream.
    
    Specified by:
    
    addMapping in interface Configuration<HibernateValidatorConfiguration>
    
    Parameters:
    stream - XML mapping stream.
    
    Returns:
    this following the chaining method pattern.
  - failFast
```
public final HibernateValidatorConfiguration failFast(boolean failFast)
```
    Description copied from interface: HibernateValidatorConfiguration
    
    En- or disables the fail fast mode. When fail fast is enabled the validation will stop on the first constraint violation detected.
    
    Specified by:
    
    failFast in interface HibernateValidatorConfiguration
    
    Parameters:
    failFast - true to enable fail fast, false otherwise.
    
    Returns:
    this following the chaining method pattern
  - addMapping
```
public final HibernateValidatorConfiguration addMapping(ConstraintMapping mapping)
```
    Description copied from interface: HibernateValidatorConfiguration
    
    Adds the specified ConstraintMapping instance to the configuration. Constraints configured in mapping will be added to the constraints configured via annotations and/or xml.
    
    Specified by:
    
    addMapping in interface HibernateValidatorConfiguration
    
    Parameters:
    mapping - ConstraintMapping instance containing programmatic configured constraints
    
    Returns:
    this following the chaining method pattern
  - addProperty
```
public final HibernateValidatorConfiguration addProperty(String name,
                                          String value)
```
    Description copied from interface: Configuration
    
    Add a provider specific property. This property is equivalent to XML configuration properties. If the underlying provider does not know how to handle the property, it must silently ignore it.
    Note: Using this non type-safe method is generally not recommended.
    It is more appropriate to use, if available, the type-safe equivalent provided by a specific provider via its Configuration subclass. ValidatorFactory factory = Validation.byProvider(ACMEPrivoder.class) .configure() .providerSpecificProperty(ACMEState.FAST) .buildValidatorFactory(); This method is typically used by containers parsing META-INF/validation.xml themselves and injecting the state to the Configuration object.
    If a property with a given name is defined both via this method and in the XML configuration, the value set programmatically has priority. If null is passed as a value, the value defined in XML is used. If no value is defined in XML, the property is considered unset.
    Specified by: addProperty in interface Configuration<HibernateValidatorConfiguration> Parameters: name - property name. value - property value. Returns: this following the chaining method pattern.
  buildValidatorFactory public final ValidatorFactory buildValidatorFactory() Description copied from interface: Configuration Build a ValidatorFactory implementation. Specified by: buildValidatorFactory in interface Configuration<HibernateValidatorConfiguration> Returns: ValidatorFactory isIgnoreXmlConfiguration public final boolean isIgnoreXmlConfiguration() Description copied from interface: ConfigurationState Returns true if Configuration.ignoreXMLConfiguration() has been called In this case, the ValidatorFactory must ignore META-INF/validation.xml Specified by: isIgnoreXmlConfiguration in interface ConfigurationState Returns: true if META-INF/validation.xml should be ignored getMessageInterpolator public final MessageInterpolator getMessageInterpolator() Description copied from interface: ConfigurationState Returns the message interpolator of this configuration. Message interpolator is defined in the following decreasing priority: set via the Configuration programmatic API defined in META-INF/validation.xml provided that ignoreXmlConfiguration is false. In this case the instance is created via its no-arg constructor. null if undefined. Specified by: getMessageInterpolator in interface ConfigurationState Returns: message provider instance or null if not defined getMappingStreams public final Set<InputStream> getMappingStreams() Description copied from interface: ConfigurationState Returns a set of configuration streams. The streams are defined by: mapping XML streams passed programmatically in Configuration mapping XML stream located in the resources defined in META-INF/validation.xml (constraint-mapping element) Streams represented in the XML configuration and opened by the Configuration implementation must be closed by the Configuration implementation after the ValidatorFactory creation (or if an exception occurs). Specified by: getMappingStreams in interface ConfigurationState Returns: set of input stream getFailFast public final boolean getFailFast() getConstraintValidatorFactory public final ConstraintValidatorFactory getConstraintValidatorFactory() Description copied from interface: ConfigurationState Returns the constraint validator factory of this configuration. The ConstraintValidatorFactory implementation is defined in the following decreasing priority: set via the Configuration programmatic API defined in META-INF/validation.xml provided that ignoredXmlConfiguration is false. In this case the instance is created via its no-arg constructor. null if undefined. Specified by: getConstraintValidatorFactory in interface ConfigurationState Returns: factory instance or null if not defined getTraversableResolver public final TraversableResolver getTraversableResolver() Description copied from interface: ConfigurationState Returns the traversable resolver for this configuration. TraversableResolver is defined in the following decreasing priority: set via the Configuration programmatic API defined in META-INF/validation.xml provided that ignoredXmlConfiguration is false. In this case the instance is created via its no-arg constructor. null if undefined. Specified by: getTraversableResolver in interface ConfigurationState Returns: traversable provider instance or null if not defined getProperties public final Map<String,String> getProperties() Description copied from interface: ConfigurationState Returns a map of non type-safe custom properties. Properties defined via: Configuration.addProperty(String, String) META-INF/validation.xml provided that ignoredXmlConfiguration is false. If a property is defined both programmatically and in XML, the value defined programmatically has priority Specified by: getProperties in interface ConfigurationState Returns: Map whose key is the property key and the value the property value getDefaultMessageInterpolator public final MessageInterpolator getDefaultMessageInterpolator() Description copied from interface: Configuration Return an implementation of the MessageInterpolator interface following the default MessageInterpolator defined in the specification: use the ValidationMessages resource bundle to load keys use Locale.getDefault() Specified by: getDefaultMessageInterpolator in interface Configuration<HibernateValidatorConfiguration> Returns: default MessageInterpolator implementation compliant with the specification getDefaultTraversableResolver public final TraversableResolver getDefaultTraversableResolver() Description copied from interface: Configuration Return an implementation of the TraversableResolver interface following the default TraversableResolver defined in the specification: if Java Persistence is available in the runtime environment, a property is considered reachable if Java Persistence considers the property as loaded if Java Persistence is not available in the runtime environment, all properties are considered reachable all properties are considered cascadable. Specified by: getDefaultTraversableResolver in interface Configuration<HibernateValidatorConfiguration> Returns: default TraversableResolver implementation compliant with the specification getDefaultConstraintValidatorFactory public final ConstraintValidatorFactory getDefaultConstraintValidatorFactory() Description copied from interface: Configuration Return an implementation of the ConstraintValidatorFactory interface following the default ConstraintValidatorFactory defined in the specification: uses the public no-arg constructor of the ConstraintValidator Specified by: getDefaultConstraintValidatorFactory in interface Configuration<HibernateValidatorConfiguration> Returns: default ConstraintValidatorFactory implementation compliant with the specification getDefaultResourceBundleLocator public final ResourceBundleLocator getDefaultResourceBundleLocator() Description copied from interface: HibernateValidatorConfiguration Returns the ResourceBundleLocator used by the default message interpolator to load user-provided resource bundles. In conformance with the specification this default locator retrieves the bundle "ValidationMessages". This locator can be used as delegate for custom locators when setting a customized ResourceBundleMessageInterpolator: HibernateValidatorConfiguration configure = Validation.byProvider(HibernateValidator.class).configure(); <p/> ResourceBundleLocator defaultResourceBundleLocator = configure.getDefaultResourceBundleLocator(); ResourceBundleLocator myResourceBundleLocator = new MyResourceBundleLocator(defaultResourceBundleLocator); <p/> configure.messageInterpolator( new ResourceBundleMessageInterpolator(myResourceBundleLocator)); Specified by: getDefaultResourceBundleLocator in interface HibernateValidatorConfiguration Returns: The default ResourceBundleLocator. Never null. getMapping public final ConstraintMapping getMapping()

Class ConfigurationImpl

Field Summary

Fields inherited from interface org.hibernate.validator.HibernateValidatorConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ConfigurationImpl

ConfigurationImpl

Method Detail

ignoreXmlConfiguration

messageInterpolator

traversableResolver

constraintValidatorFactory

addMapping

failFast

addMapping

addProperty

buildValidatorFactory

isIgnoreXmlConfiguration

getMessageInterpolator

getMappingStreams

getFailFast

getConstraintValidatorFactory

getTraversableResolver

getProperties

getDefaultMessageInterpolator

getDefaultTraversableResolver

getDefaultConstraintValidatorFactory

getDefaultResourceBundleLocator

getMapping