org.apache.bval.jsr

Class ApacheValidatorFactory

java.lang.Object

org.apache.bval.jsr.ApacheValidatorFactory

All Implemented Interfaces:

Cloneable, javax.validation.ValidatorFactory

public class ApacheValidatorFactory
extends Object
implements javax.validation.ValidatorFactory, Cloneable

Description: a factory is a complete configurated object that can create validators.
This instance is not thread-safe.

Constructor Summary

Constructors

Constructor and Description
ApacheValidatorFactory(javax.validation.spi.ConfigurationState configuration) Create a new ApacheValidatorFactory instance.

Method Summary

Modifier and Type	Method and Description
void	addDefaultSequence(Class<?> beanClass, Class<?>... groupSequence) Set the default group sequence for a particular bean class.
void	addMetaConstraint(Class<?> beanClass, MetaConstraint<?,?> metaConstraint) Add a meta-constraint to this ApacheValidatorFactory's runtime customizations.
void	addValid(Class<?> beanClass, AccessStrategy accessStrategy) Mark a property of beanClass for nested validation.
protected MetaBeanFinder	buildMetaBeanFinder() Create MetaBeanManager that uses factories: if enabled by ApacheValidatorConfiguration.Properties.ENABLE_INTROSPECTOR, an IntrospectorMetaBeanFactory MetaBeanFactory types (if any) specified by ApacheValidatorConfiguration.Properties.METABEAN_FACTORY_CLASSNAMES if no JsrMetaBeanFactory has yet been specified (this allows factory order customization), a JsrMetaBeanFactory which handles both JSR303-XML and JSR303-Annotations if enabled by ApacheValidatorConfiguration.Properties.ENABLE_METABEANS_XML, an XMLMetaBeanFactory
ApacheValidatorFactory	clone()
void	close()
protected MetaBeanFinder	createMetaBeanManager(List<MetaBeanFactory> builders) Create a MetaBeanManager using the specified builders.
AnnotationIgnores	getAnnotationIgnores() Get the detected AnnotationIgnores.
ConstraintCached	getConstraintsCache() Get the constraint cache used.
javax.validation.ConstraintValidatorFactory	getConstraintValidatorFactory()
static ApacheValidatorFactory	getDefault() Convenience method to retrieve a default global ApacheValidatorFactory
ConstraintDefaults	getDefaultConstraints() Get the detected ConstraintDefaults.
Class<?>[]	getDefaultSequence(Class<?> beanClass) Get the default group sequence configured for beanClass.
javax.validation.MessageInterpolator	getMessageInterpolator()
<T> List<MetaConstraint<T,? extends Annotation>>	getMetaConstraints(Class<T> beanClass) Retrieve the runtime constraint configuration for a given class.
javax.validation.ParameterNameProvider	getParameterNameProvider()
Map<String,String>	getProperties() Get the property map of this ApacheValidatorFactory.
javax.validation.TraversableResolver	getTraversableResolver()
List<AccessStrategy>	getValidAccesses(Class<?> beanClass) Get the AccessStrategy List indicating nested bean validations that must be triggered in the course of validating a beanClass graph.
javax.validation.Validator	getValidator() Shortcut method to create a new Validator instance with factory's settings
void	setConstraintValidatorFactory(javax.validation.ConstraintValidatorFactory constraintValidatorFactory) Set the ConstraintValidatorFactory used.
static void	setDefault(ApacheValidatorFactory aDefaultFactory) Set a particular ApacheValidatorFactory instance as the default.
void	setMessageInterpolator(javax.validation.MessageInterpolator messageResolver) Set the MessageInterpolator used.
void	setParameterNameProvider(javax.validation.ParameterNameProvider parameterNameProvider)
void	setTraversableResolver(javax.validation.TraversableResolver traversableResolver) Set the TraversableResolver used.
<T> T	unwrap(Class<T> type) Return an object of the specified type to allow access to the provider-specific API.
ApacheFactoryContext	usingContext()

Methods inherited from class java.lang.Object

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

Constructor Detail

ApacheValidatorFactory

public ApacheValidatorFactory(javax.validation.spi.ConfigurationState configuration)

Create a new ApacheValidatorFactory instance.

Method Detail

buildMetaBeanFinder

protected MetaBeanFinder buildMetaBeanFinder()

Create MetaBeanManager that uses factories:

1. if enabled by ApacheValidatorConfiguration.Properties.ENABLE_INTROSPECTOR, an IntrospectorMetaBeanFactory
2. MetaBeanFactory types (if any) specified by ApacheValidatorConfiguration.Properties.METABEAN_FACTORY_CLASSNAMES
3. if no JsrMetaBeanFactory has yet been specified (this allows factory order customization), a JsrMetaBeanFactory which handles both JSR303-XML and JSR303-Annotations
4. if enabled by ApacheValidatorConfiguration.Properties.ENABLE_METABEANS_XML, an XMLMetaBeanFactory

Returns:

a new instance of MetaBeanManager with adequate MetaBeanFactories

getDefault

public static ApacheValidatorFactory getDefault()

Convenience method to retrieve a default global ApacheValidatorFactory

Returns:

ApacheValidatorFactory

setDefault

public static void setDefault(ApacheValidatorFactory aDefaultFactory)

Set a particular ApacheValidatorFactory instance as the default.

Parameters:

aDefaultFactory -

getProperties

public Map<String,String> getProperties()

Get the property map of this ApacheValidatorFactory.

Returns:

Map

getValidator

public javax.validation.Validator getValidator()

Shortcut method to create a new Validator instance with factory's settings

Specified by:

getValidator in interface javax.validation.ValidatorFactory

Returns:

the new validator instance

usingContext

public ApacheFactoryContext usingContext()

Specified by:

usingContext in interface javax.validation.ValidatorFactory

Returns:

the validator factory's context

clone

public ApacheValidatorFactory clone()

Overrides:

clone in class Object

setMessageInterpolator

public final void setMessageInterpolator(javax.validation.MessageInterpolator messageResolver)

Set the MessageInterpolator used.

Parameters:

messageResolver -

getMessageInterpolator

public javax.validation.MessageInterpolator getMessageInterpolator()

Specified by:

getMessageInterpolator in interface javax.validation.ValidatorFactory

setTraversableResolver

public final void setTraversableResolver(javax.validation.TraversableResolver traversableResolver)

Set the TraversableResolver used.

Parameters:

traversableResolver -

setParameterNameProvider

public void setParameterNameProvider(javax.validation.ParameterNameProvider parameterNameProvider)

getTraversableResolver

public javax.validation.TraversableResolver getTraversableResolver()

Specified by:

getTraversableResolver in interface javax.validation.ValidatorFactory

setConstraintValidatorFactory

public final void setConstraintValidatorFactory(javax.validation.ConstraintValidatorFactory constraintValidatorFactory)

Set the ConstraintValidatorFactory used.

Parameters:

constraintValidatorFactory -

getConstraintValidatorFactory

public javax.validation.ConstraintValidatorFactory getConstraintValidatorFactory()

Specified by:

getConstraintValidatorFactory in interface javax.validation.ValidatorFactory

getParameterNameProvider

public javax.validation.ParameterNameProvider getParameterNameProvider()

Specified by:

getParameterNameProvider in interface javax.validation.ValidatorFactory

close

public void close()

Specified by:

close in interface javax.validation.ValidatorFactory

unwrap

public <T> T unwrap(Class<T> type)

Return an object of the specified type to allow access to the provider-specific API. If the Bean Validation provider implementation does not support the specified class, the ValidationException is thrown.

Specified by:

unwrap in interface javax.validation.ValidatorFactory

Parameters:

type - the class of the object to be returned.

Returns:

an instance of the specified class

Throws:

javax.validation.ValidationException - if the provider does not support the call.

getDefaultConstraints

public ConstraintDefaults getDefaultConstraints()

Get the detected ConstraintDefaults.

Returns:

ConstraintDefaults

getAnnotationIgnores

public AnnotationIgnores getAnnotationIgnores()

Get the detected AnnotationIgnores.

Returns:

AnnotationIgnores

getConstraintsCache

public ConstraintCached getConstraintsCache()

Get the constraint cache used.

Returns:

ConstraintCached

addMetaConstraint

public void addMetaConstraint(Class<?> beanClass,
                              MetaConstraint<?,?> metaConstraint)

Add a meta-constraint to this ApacheValidatorFactory's runtime customizations.

Parameters:

beanClass -

metaConstraint -

addValid

public void addValid(Class<?> beanClass,
                     AccessStrategy accessStrategy)

Mark a property of beanClass for nested validation.

Parameters:

beanClass -

accessStrategy - defining the property to validate

addDefaultSequence

public void addDefaultSequence(Class<?> beanClass,
                               Class<?>... groupSequence)

Set the default group sequence for a particular bean class.

Parameters:

beanClass -

groupSequence -

getMetaConstraints

public <T> List<MetaConstraint<T,? extends Annotation>> getMetaConstraints(Class<T> beanClass)

Retrieve the runtime constraint configuration for a given class.

Type Parameters:

T -

Parameters:

beanClass -

Returns:

List of MetaConstraints applicable to beanClass

getValidAccesses

public List<AccessStrategy> getValidAccesses(Class<?> beanClass)

Get the AccessStrategy List indicating nested bean validations that must be triggered in the course of validating a beanClass graph.

Parameters:

beanClass -

Returns:

List of AccessStrategy

getDefaultSequence

public Class<?>[] getDefaultSequence(Class<?> beanClass)

Get the default group sequence configured for beanClass.

Parameters:

beanClass -

Returns:

group Class array

createMetaBeanManager

protected MetaBeanFinder createMetaBeanManager(List<MetaBeanFactory> builders)

Create a MetaBeanManager using the specified builders.

Parameters:

builders - MetaBeanFactory List

Returns:

MetaBeanManager