Package javax.validation.spi
Interface ConfigurationState
public interface ConfigurationState
Contract between a
Configuration
and a
ValidationProvider
to create a ValidatorFactory
.
The configuration artifacts defined in the XML configuration and provided to the
Configuration
are merged and passed along via
ConfigurationState
.-
Method Summary
Modifier and TypeMethodDescriptionReturns the constraint validator factory of this configuration.Returns a set of configuration streams.Returns the message interpolator of this configuration.Returns the parameter name provider for this configuration.Returns a map of non type-safe custom properties.Returns the traversable resolver for this configuration.boolean
Returnstrue
ifConfiguration.ignoreXmlConfiguration()
has been called.
-
Method Details
-
isIgnoreXmlConfiguration
boolean isIgnoreXmlConfiguration()Returnstrue
ifConfiguration.ignoreXmlConfiguration()
has been called. In this case, theValidatorFactory
must ignoreMETA-INF/validation.xml
.- Returns:
true
ifMETA-INF/validation.xml
should be ignored
-
getMessageInterpolator
MessageInterpolator getMessageInterpolator()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 thatignoreXmlConfiguration
is false. In this case the instance is created via its no-arg constructor. null
if undefined.
- Returns:
- message interpolator instance or
null
if not defined
- set via the
-
getMappingStreams
Set<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)
Configuration
implementation must be closed by theConfiguration
implementation after theValidatorFactory
creation (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. TheConstraintValidatorFactory
implementation is defined in the following decreasing priority:- set via the
Configuration
programmatic API - defined in
META-INF/validation.xml
provided thatignoredXmlConfiguration
isfalse
. In this case the instance is created via its no-arg constructor. null
if undefined.
- Returns:
- factory instance or
null
if not defined
- set via the
-
getTraversableResolver
TraversableResolver getTraversableResolver()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 thatignoredXmlConfiguration
isfalse
. In this case the instance is created via its no-arg constructor. null
if undefined.
- Returns:
- traversable resolver instance or
null
if not defined
- set via the
-
getParameterNameProvider
ParameterNameProvider getParameterNameProvider()Returns the parameter name provider for this configuration.ParameterNameProvider
is defined in the following decreasing priority:- set via the
Configuration
programmatic API - defined in
META-INF/validation.xml
provided thatignoreXmlConfiguration
isfalse
. In this case the instance is created via its no-arg constructor. null
if undefined.
- Returns:
- parameter name provider instance or
null
if not defined - Since:
- 1.1
- set via the
-
getProperties
Returns a map of non type-safe custom properties. Properties defined via:Configuration.addProperty(String, String)
META-INF/validation.xml
provided thatignoreXmlConfiguration
is
false
.- Returns:
Map
whose key is the property key and the value the property value
-