Jakarta EE 11.0.0 · jakarta.validation.spi.ConfigurationState

Method Summary

Modifier and Type	Method and Description
public ClockProvider	Returns: clock provider instance or `null` if not defined getClockProvider() Returns the clock provider for this configuration.
public ConstraintValidatorFactory	Returns: factory instance or `null` if not defined getConstraintValidatorFactory() Returns the constraint validator factory of this configuration.
public Set<InputStream>	Returns: set of input stream getMappingStreams() Returns a set of configuration streams.
public MessageInterpolator	Returns: message interpolator instance or `null` if not defined getMessageInterpolator() Returns the message interpolator of this configuration.
public ParameterNameProvider	Returns: parameter name provider instance or `null` if not defined getParameterNameProvider() Returns the parameter name provider for this configuration.
public Map<String, String>	Returns: `Map` whose key is the property key and the value the property value getProperties() Returns a map of non type-safe custom properties.
public TraversableResolver	Returns: traversable resolver instance or `null` if not defined getTraversableResolver() Returns the traversable resolver for this configuration.
public Set<ValueExtractor<?>>	Returns: set of value extractors; may be empty but never `null` getValueExtractors() Returns a set of value extractors.
public boolean	Returns: `true` if `META-INF/validation.xml` should be ignored isIgnoreXmlConfiguration() Returns `true` if `Configuration#ignoreXmlConfiguration()` has been called.

Method Detail

getClockProvider back to summary

getClockProvider	back to summary
public ClockProvider getClockProvider() Returns the clock provider for this configuration. `ClockProvider` 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. Returns:ClockProvider clock provider instance or `null` if not defined Since 2.0

public ClockProvider getClockProvider()

Returns the clock provider for this configuration.

ClockProvider 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.

Returns:ClockProvider: clock provider instance or null if not defined
Since: 2.0

getConstraintValidatorFactory back to summary

getConstraintValidatorFactory	back to summary
public ConstraintValidatorFactory getConstraintValidatorFactory() 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. Returns:ConstraintValidatorFactory factory instance or `null` if not defined

public ConstraintValidatorFactory getConstraintValidatorFactory()

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.

Returns:ConstraintValidatorFactory: factory instance or null if not defined

getMappingStreams back to summary

getMappingStreams	back to summary
public 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) 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). All streams are guaranteed to adhere to the mark/reset contract (see `InputStream#markSupported()` by the Jakarta Validation provider. Returns:Set<InputStream> set of input stream

public 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)

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). All streams are guaranteed to adhere to the mark/reset contract (see InputStream#markSupported() by the Jakarta Validation provider.

Returns:Set<InputStream>: set of input stream

getMessageInterpolator back to summary

getMessageInterpolator	back to summary
public 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 that `ignoreXmlConfiguration` is false. In this case the instance is created via its no-arg constructor. `null` if undefined. Returns:MessageInterpolator message interpolator instance or `null` if not defined

public 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 that ignoreXmlConfiguration is false. In this case the instance is created via its no-arg constructor.
null if undefined.

Returns:MessageInterpolator: message interpolator instance or null if not defined

getParameterNameProvider back to summary

getParameterNameProvider	back to summary
public 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 that `ignoreXmlConfiguration` is `false`. In this case the instance is created via its no-arg constructor. `null` if undefined. Returns:ParameterNameProvider parameter name provider instance or `null` if not defined Since 1.1

public 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 that ignoreXmlConfiguration is false. In this case the instance is created via its no-arg constructor.
null if undefined.

Returns:ParameterNameProvider: parameter name provider instance or null if not defined
Since: 1.1

getProperties back to summary

getProperties	back to summary
public Map<String, String> getProperties() Returns a map of non type-safe custom properties. Properties defined via: `Configuration#addProperty(String, String)` `META-INF/validation.xml` provided that `ignoreXmlConfiguration` is `false`. If a property is defined both programmatically and in XML, the value defined programmatically has priority. Returns:Map<String, String> `Map` whose key is the property key and the value the property value

public Map<String, String> getProperties()

Returns a map of non type-safe custom properties.

Properties defined via:

Configuration#addProperty(String, String)
META-INF/validation.xml provided that ignoreXmlConfiguration is false.

If a property is defined both programmatically and in XML, the value defined programmatically has priority.

Returns:Map<String, String>: Map whose key is the property key and the value the property value

getTraversableResolver back to summary

getTraversableResolver	back to summary
public 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 that `ignoredXmlConfiguration` is `false`. In this case the instance is created via its no-arg constructor. `null` if undefined. Returns:TraversableResolver traversable resolver instance or `null` if not defined

public 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 that ignoredXmlConfiguration is false. In this case the instance is created via its no-arg constructor.
null if undefined.

Returns:TraversableResolver: traversable resolver instance or null if not defined

getValueExtractors back to summary

getValueExtractors	back to summary
public Set<ValueExtractor<?>> getValueExtractors() Returns a set of value extractors. The extractors are retrieved from the following sources in decreasing order: extractors passed programmatically to `Configuration` extractors defined in `META-INF/validation.xml` provided that `ignoredXmlConfiguration` is `false` extractors loaded through the Java service loader An extractor for a given type and type parameter passed in programmatically takes precedence over any extractor for the same type and type parameter defined in `META-INF/validation.xml` or loaded through the service loader. Extractors defined in `META-INF/validation.xml` take precedence over any extractor for the same type and type parameter loaded through the service loader. Extractors defined in `META-INF/validation.xml` or loaded through the service loader are instantiated using their no-arg constructor. Returns:Set<ValueExtractor<?>> set of value extractors; may be empty but never `null` Since 2.0

public Set<ValueExtractor<?>> getValueExtractors()

Returns a set of value extractors.

The extractors are retrieved from the following sources in decreasing order:

extractors passed programmatically to Configuration
extractors defined in META-INF/validation.xml provided that ignoredXmlConfiguration is false
extractors loaded through the Java service loader

An extractor for a given type and type parameter passed in programmatically takes precedence over any extractor for the same type and type parameter defined in META-INF/validation.xml or loaded through the service loader. Extractors defined in META-INF/validation.xml take precedence over any extractor for the same type and type parameter loaded through the service loader.

Extractors defined in META-INF/validation.xml or loaded through the service loader are instantiated using their no-arg constructor.

Returns:Set<ValueExtractor<?>>: set of value extractors; may be empty but never null
Since: 2.0

isIgnoreXmlConfiguration back to summary

isIgnoreXmlConfiguration	back to summary
public boolean isIgnoreXmlConfiguration() Returns `true` if `Configuration#ignoreXmlConfiguration()` has been called. In this case, the `ValidatorFactory` must ignore `META-INF/validation.xml`. Returns:boolean `true` if `META-INF/validation.xml` should be ignored

public boolean isIgnoreXmlConfiguration()

Returns true if Configuration#ignoreXmlConfiguration() has been called.

In this case, the ValidatorFactory must ignore META-INF/validation.xml.

Returns:boolean: true if META-INF/validation.xml should be ignored

public Interface ConfigurationState

Method Summary

Method Detail