ConfigurationState (Java EE 6 )

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES All Classes

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.validation.spi
Interface ConfigurationState

public interface ConfigurationState

Contract between a Configuration and a ValidatorProvider to create a ValidatorFactory. The configuration artifacts defined in the XML configuration and provided to the Configuration are merged and passed along via ConfigurationState.

Author:: Emmanuel Bernard, Hardy Ferentschik

Method Summary
`ConstraintValidatorFactory`	`getConstraintValidatorFactory()` Returns the constraint validator factory of this configuration.
`java.util.Set<java.io.InputStream>`	`getMappingStreams()` Returns a set of configuration streams.
`MessageInterpolator`	`getMessageInterpolator()` Returns the message interpolator of this configuration.
`java.util.Map<java.lang.String,java.lang.String>`	`getProperties()` Returns a map of non type-safe custom properties.
`TraversableResolver`	`getTraversableResolver()` Returns the traversable resolver for this configuration.
`boolean`	`isIgnoreXmlConfiguration()` Returns true if Configuration.ignoreXMLConfiguration() has been called In this case, the ValidatorFactory must ignore META-INF/validation.xml

Method Detail

isIgnoreXmlConfiguration

boolean isIgnoreXmlConfiguration()

Returns true if Configuration.ignoreXMLConfiguration() has been called In this case, the ValidatorFactory must ignore META-INF/validation.xml

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

Returns:: message provider instance or null if not defined

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 stream located in the resources defined in

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

Returns:: set of input stream

getConstraintValidatorFactory

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:: factory instance or null if not defined

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

Returns:: traversable provider instance or null if not defined

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.xml provided that ignoredXmlConfiguration

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

Returns:: Map whose key is the property key and the value the property value