org.apache.bval.jsr303
Class ConfigurationImpl

java.lang.Object
  org.apache.bval.jsr303.ConfigurationImpl

All Implemented Interfaces:

Configuration<ApacheValidatorConfiguration>, ConfigurationState, ApacheValidatorConfiguration

public class ConfigurationImpl
extends Object
implements ApacheValidatorConfiguration, ConfigurationState

Description: used to configure apache-validation for jsr303. Implementation of Configuration that also implements ConfigurationState, hence this can be passed to buildValidatorFactory(ConfigurationState).

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.bval.jsr303.ApacheValidatorConfiguration

ApacheValidatorConfiguration.Properties

Field Summary

protected ConstraintValidatorFactory	constraintValidatorFactory Configured ConstraintValidatorFactory
protected MessageInterpolator	defaultMessageInterpolator Default MessageInterpolator
protected MessageInterpolator	messageInterpolator Configured MessageInterpolator
protected ValidationProvider<?>	provider Configured ValidationProvider
protected Class<? extends ValidationProvider<?>>	providerClass Configured ValidationProvider class
protected ValidationProviderResolver	providerResolver Configured ValidationProviderResolver

Constructor Summary

ConfigurationImpl(BootstrapState aState, ValidationProvider<?> aProvider)
Create a new ConfigurationImpl instance.

Method Summary

ApacheValidatorConfiguration	addMapping(InputStream stream) Add a stream describing constraint mapping in the Bean Validation XML format.
ApacheValidatorConfiguration	addProperty(String name, String value) Add a provider specific property.
ValidatorFactory	buildValidatorFactory() main factory method to build a ValidatorFactory
ConfigurationImpl	constraintValidatorFactory(ConstraintValidatorFactory constraintFactory)
ValidatorFactory	doPrivBuildValidatorFactory()
ConstraintValidatorFactory	getConstraintValidatorFactory()
ConstraintValidatorFactory	getDefaultConstraintValidatorFactory()
MessageInterpolator	getDefaultMessageInterpolator()
TraversableResolver	getDefaultTraversableResolver()
Set<InputStream>	getMappingStreams()
MessageInterpolator	getMessageInterpolator()
Map<String,String>	getProperties() Return a map of non type-safe custom properties.
ValidationProvider<?>	getProvider() Get the configured ValidationProvider.
TraversableResolver	getTraversableResolver()
ApacheValidatorConfiguration	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.
ConfigurationImpl	messageInterpolator(MessageInterpolator resolver)
void	setProviderClass(Class<? extends ValidationProvider<?>> providerClass) Set ValidationProvider class.
ApacheValidatorConfiguration	traversableResolver(TraversableResolver resolver)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

provider

protected final ValidationProvider<?> provider

Configured ValidationProvider

providerResolver

protected final ValidationProviderResolver providerResolver

Configured ValidationProviderResolver

providerClass

protected Class<? extends ValidationProvider<?>> providerClass

Configured ValidationProvider class

messageInterpolator

protected MessageInterpolator messageInterpolator

Configured MessageInterpolator

constraintValidatorFactory

protected ConstraintValidatorFactory constraintValidatorFactory

Configured ConstraintValidatorFactory

defaultMessageInterpolator

protected final MessageInterpolator defaultMessageInterpolator

Default MessageInterpolator

Constructor Detail

ConfigurationImpl

public ConfigurationImpl(BootstrapState aState,
                         ValidationProvider<?> aProvider)

Create a new ConfigurationImpl instance.

Parameters:

aState -

aProvider -

Method Detail

traversableResolver

public ApacheValidatorConfiguration traversableResolver(TraversableResolver resolver)

Specified by:

traversableResolver in interface Configuration<ApacheValidatorConfiguration>

ignoreXmlConfiguration

public ApacheValidatorConfiguration ignoreXmlConfiguration()

Ignore data from the META-INF/validation.xml file if this method is called.

Specified by:

ignoreXmlConfiguration in interface Configuration<ApacheValidatorConfiguration>

Returns:

this

messageInterpolator

public ConfigurationImpl messageInterpolator(MessageInterpolator resolver)

Specified by:

messageInterpolator in interface Configuration<ApacheValidatorConfiguration>

constraintValidatorFactory

public ConfigurationImpl constraintValidatorFactory(ConstraintValidatorFactory constraintFactory)

Specified by:

constraintValidatorFactory in interface Configuration<ApacheValidatorConfiguration>

addMapping

public ApacheValidatorConfiguration addMapping(InputStream stream)

Add a stream describing constraint mapping in the Bean Validation XML format.

Specified by:

addMapping in interface Configuration<ApacheValidatorConfiguration>

Returns:

this

addProperty

public ApacheValidatorConfiguration addProperty(String name,
                                                String value)

Add a provider specific property. This property is equivalent to XML configuration properties. If we do not know how to handle the property, we silently ignore it.

Specified by:

addProperty in interface Configuration<ApacheValidatorConfiguration>

Returns:

this

getProperties

public Map<String,String> getProperties()

Return a map of non type-safe custom properties.

Specified by:

getProperties in interface ConfigurationState

Returns:

null

isIgnoreXmlConfiguration

public boolean isIgnoreXmlConfiguration()

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

Specified by:

isIgnoreXmlConfiguration in interface ConfigurationState

Returns:

true

getMappingStreams

public Set<InputStream> getMappingStreams()

Specified by:

getMappingStreams in interface ConfigurationState

getMessageInterpolator

public MessageInterpolator getMessageInterpolator()

Specified by:

getMessageInterpolator in interface ConfigurationState

getDefaultMessageInterpolator

public MessageInterpolator getDefaultMessageInterpolator()

Specified by:

getDefaultMessageInterpolator in interface Configuration<ApacheValidatorConfiguration>

getDefaultTraversableResolver

public TraversableResolver getDefaultTraversableResolver()

Specified by:

getDefaultTraversableResolver in interface Configuration<ApacheValidatorConfiguration>

getDefaultConstraintValidatorFactory

public ConstraintValidatorFactory getDefaultConstraintValidatorFactory()

Specified by:

getDefaultConstraintValidatorFactory in interface Configuration<ApacheValidatorConfiguration>

buildValidatorFactory

public ValidatorFactory buildValidatorFactory()

main factory method to build a ValidatorFactory

Specified by:

buildValidatorFactory in interface Configuration<ApacheValidatorConfiguration>

Throws:

ValidationException - if the ValidatorFactory cannot be built

doPrivBuildValidatorFactory

public ValidatorFactory doPrivBuildValidatorFactory()

getConstraintValidatorFactory

public ConstraintValidatorFactory getConstraintValidatorFactory()

Specified by:

getConstraintValidatorFactory in interface ConfigurationState

Returns:

the constraint validator factory of this configuration.

getTraversableResolver

public TraversableResolver getTraversableResolver()

Specified by:

getTraversableResolver in interface ConfigurationState

getProvider

public ValidationProvider<?> getProvider()

Get the configured ValidationProvider.

Returns:

ValidationProvider

setProviderClass

public void setProviderClass(Class<? extends ValidationProvider<?>> providerClass)

Set ValidationProvider class.

Parameters:

providerClass -