Package javax.validation.spi
Interface ConfigurationState
-
public interface ConfigurationStateContract between aConfigurationand aValidationProviderto create aValidatorFactory. The configuration artifacts defined in the XML configuration and provided to theConfigurationare merged and passed along viaConfigurationState.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ConstraintValidatorFactorygetConstraintValidatorFactory()Returns the constraint validator factory of this configuration.java.util.Set<java.io.InputStream>getMappingStreams()Returns a set of configuration streams.MessageInterpolatorgetMessageInterpolator()Returns the message interpolator of this configuration.ParameterNameProvidergetParameterNameProvider()Returns the parameter name provider for this configuration.java.util.Map<java.lang.String,java.lang.String>getProperties()Returns a map of non type-safe custom properties.TraversableResolvergetTraversableResolver()Returns the traversable resolver for this configuration.booleanisIgnoreXmlConfiguration()ReturnstrueifConfiguration.ignoreXmlConfiguration()has been called.
-
-
-
Method Detail
-
isIgnoreXmlConfiguration
boolean isIgnoreXmlConfiguration()
ReturnstrueifConfiguration.ignoreXmlConfiguration()has been called. In this case, theValidatorFactorymust ignoreMETA-INF/validation.xml.- Returns:
trueifMETA-INF/validation.xmlshould be ignored
-
getMessageInterpolator
MessageInterpolator getMessageInterpolator()
Returns the message interpolator of this configuration. Message interpolator is defined in the following decreasing priority:- set via the
Configurationprogrammatic API - defined in
META-INF/validation.xmlprovided thatignoreXmlConfigurationis false. In this case the instance is created via its no-arg constructor. nullif undefined.
- Returns:
- message interpolator instance or
nullif not defined
- set via the
-
getMappingStreams
java.util.Set<java.io.InputStream> getMappingStreams()
Returns a set of configuration streams. The streams are defined by:- mapping XML streams passed programmatically in
Configuration - mapping XML streams located in the resources defined in
META-INF/validation.xml(constraint-mapping element)
Configurationimplementation must be closed by theConfigurationimplementation after theValidatorFactorycreation (or if an exception occurs). All streams are guaranteed to adhere to the mark/reset contract (seeInputStream.markSupported()by the Bean Validation provider.- Returns:
- set of input stream
- mapping XML streams passed programmatically in
-
getConstraintValidatorFactory
ConstraintValidatorFactory getConstraintValidatorFactory()
Returns the constraint validator factory of this configuration. TheConstraintValidatorFactoryimplementation is defined in the following decreasing priority:- set via the
Configurationprogrammatic API - defined in
META-INF/validation.xmlprovided thatignoredXmlConfigurationisfalse. In this case the instance is created via its no-arg constructor. nullif undefined.
- Returns:
- factory instance or
nullif not defined
- set via the
-
getTraversableResolver
TraversableResolver getTraversableResolver()
Returns the traversable resolver for this configuration.TraversableResolveris defined in the following decreasing priority:- set via the
Configurationprogrammatic API - defined in
META-INF/validation.xmlprovided thatignoredXmlConfigurationisfalse. In this case the instance is created via its no-arg constructor. nullif undefined.
- Returns:
- traversable resolver instance or
nullif not defined
- set via the
-
getParameterNameProvider
ParameterNameProvider getParameterNameProvider()
Returns the parameter name provider for this configuration.ParameterNameProvideris defined in the following decreasing priority:- set via the
Configurationprogrammatic API - defined in
META-INF/validation.xmlprovided thatignoreXmlConfigurationisfalse. In this case the instance is created via its no-arg constructor. nullif undefined.
- Returns:
- parameter name provider instance or
nullif not defined - Since:
- 1.1
- set via the
-
getProperties
java.util.Map<java.lang.String,java.lang.String> getProperties()
Returns a map of non type-safe custom properties. Properties defined via:Configuration.addProperty(String, String)META-INF/validation.xmlprovided thatignoreXmlConfiguration is
false.- Returns:
Mapwhose key is the property key and the value the property value
-
-