org.hibernate.validator.internal.metadata.core

Class ConstraintHelper

java.lang.Object

org.hibernate.validator.internal.metadata.core.ConstraintHelper

public class ConstraintHelper
extends Object

Keeps track of builtin constraints and their validator implementations, as well as already resolved validator definitions.

Author:

Hardy Ferentschik, Alaa Nassef, Gunnar Morling

Constructor Summary

Constructors

Constructor and Description
ConstraintHelper()

Method Summary

Methods

Modifier and Type	Method and Description
<A extends Annotation> void	addConstraintValidatorDefinition(Class<A> annotationClass, List<Class<? extends ConstraintValidator<? extends Annotation,?>>> definitionClasses)
boolean	containsConstraintValidatorDefinition(Class<? extends Annotation> annotationClass)
List<Class<? extends ConstraintValidator<? extends Annotation,?>>>	getBuiltInConstraints(Class<? extends Annotation> annotationClass)
<A extends Annotation> List<Annotation>	getConstraintsFromMultiValueConstraint(A multiValueConstraint) Returns the constraints which are part of the given multi-value constraint.
<T extends Annotation> List<Class<? extends ConstraintValidator<T,?>>>	getConstraintValidatorDefinition(Class<T> annotationClass)
boolean	isBuiltinConstraint(Class<? extends Annotation> annotationType)
boolean	isConstraintAnnotation(Class<? extends Annotation> annotationType) Checks whether the specified annotation is a valid constraint annotation.
boolean	isConstraintComposition(Class<? extends Annotation> annotationType)
boolean	isMultiValueConstraint(Class<? extends Annotation> annotationType) Checks whether a given annotation is a multi value constraint or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConstraintHelper

public ConstraintHelper()

Method Detail

getBuiltInConstraints

public List<Class<? extends ConstraintValidator<? extends Annotation,?>>> getBuiltInConstraints(Class<? extends Annotation> annotationClass)

isBuiltinConstraint

public boolean isBuiltinConstraint(Class<? extends Annotation> annotationType)

isMultiValueConstraint

public boolean isMultiValueConstraint(Class<? extends Annotation> annotationType)

Checks whether a given annotation is a multi value constraint or not.

Parameters:

annotationType - the annotation type to check.

Returns:

true if the specified annotation is a multi value constraints, false otherwise.

getConstraintsFromMultiValueConstraint

public <A extends Annotation> List<Annotation> getConstraintsFromMultiValueConstraint(A multiValueConstraint)

Returns the constraints which are part of the given multi-value constraint.

Invoke isMultiValueConstraint(Class) prior to calling this method to check whether a given constraint actually is a multi-value constraint.

Type Parameters:

A - the type of the annotation

Parameters:

multiValueConstraint - the multi-value constraint annotation from which to retrieve the contained constraints

Returns:

A list of constraint annotations, may be empty but never null.

isConstraintAnnotation

public boolean isConstraintAnnotation(Class<? extends Annotation> annotationType)

Checks whether the specified annotation is a valid constraint annotation. A constraint annotations has to fulfill the following conditions:

• Has to contain a ConstraintValidator implementation.
• Defines a message parameter.
• Defines a group parameter.
• Defines a payload parameter.

Parameters:

annotationType - The annotation type to test.

Returns:

true if the annotation fulfills the above condtions, false otherwise.

getConstraintValidatorDefinition

public <T extends Annotation> List<Class<? extends ConstraintValidator<T,?>>> getConstraintValidatorDefinition(Class<T> annotationClass)

addConstraintValidatorDefinition

public <A extends Annotation> void addConstraintValidatorDefinition(Class<A> annotationClass,
                                                           List<Class<? extends ConstraintValidator<? extends Annotation,?>>> definitionClasses)

containsConstraintValidatorDefinition

public boolean containsConstraintValidatorDefinition(Class<? extends Annotation> annotationClass)

isConstraintComposition

public boolean isConstraintComposition(Class<? extends Annotation> annotationType)