Modifier and Type	Class and Description
private static class	ConstraintHelper.ValidatorDescriptorMap A type-safe wrapper around a concurrent map from constraint types to associated validator classes.

Modifier and Type	Field and Description
private final Map<Class<? extends Annotation>, List<? extends ConstraintValidatorDescriptor<?>>>	enabledBuiltinConstraints
private final ConcurrentMap<Class<? extends Annotation>, Boolean>	externalConstraints
public static final String	GROUPS
private static final String	JAVA_MONEY_CLASS_NAME
private Boolean	javaMoneyInClasspath
private static final String	JODA_TIME_CLASS_NAME
private Boolean	jodaTimeInClassPath
private static final Log	LOG
public static final String	MESSAGE
private final ConcurrentMap<Class<? extends Annotation>, Boolean>	multiValueConstraints
public static final String	PAYLOAD
private static final List<String>	SUPPORTED_VALID_METHODS
public static final String	VALIDATION_APPLIES_TO
private final ConstraintHelper.ValidatorDescriptorMap	validatorDescriptors

Access	Constructor and Description
private	ConstraintHelper(Set<BuiltinConstraint> enabledBuiltinConstraints)

Method Summary

Modifier and Type	Method and Description
private void	assertGroupsParameterExists(Class<? extends Annotation> annotationType)
private void	assertMessageParameterExists(Class<? extends Annotation> annotationType)
private void	assertNoParameterStartsWithValid(Class<? extends Annotation> annotationType)
private void	assertPayloadParameterExists(Class<? extends Annotation> annotationType)
private void	assertValidationAppliesToParameterSetUpCorrectly(Class<? extends Annotation> annotationType)
public void	clear()
public < the type of the annotation A extends Annotation> List<ConstraintValidatorDescriptor<A>>	Returns: A list with matching validator descriptors. findValidatorDescriptors(Class<A> The annotation of interest. annotationType, ValidationTarget The target, either annotated element or parameters. validationTarget) Returns those validator descriptors for the given constraint annotation matching the given target.
public static ConstraintHelper	forAllBuiltinConstraints()
public static ConstraintHelper	forBuiltinConstraints(Set<String> enabledConstraints)
public < the type of the annotation A extends Annotation> List<ConstraintValidatorDescriptor<A>>	Returns: The validator classes for the given type. getAllValidatorDescriptors(Class<A> The constraint annotation type. annotationType) Returns the constraint validator classes for the given constraint annotation type, as retrieved from `Constraint#validatedBy()`, internally registered validators for built-in constraints XML configuration and programmatically registered validators (see `org.hibernate.validator.cfg.ConstraintMapping#constraintDefinition(Class)`).
public static Set<String>	getBuiltinConstraints()
public < the type of the annotation A extends Annotation> List<Annotation>	Returns: A list of constraint annotations, may be empty but never `null`. getConstraintsFromMultiValueConstraint(A the multi-value constraint annotation from which to retrieve the contained constraints multiValueConstraint) Returns the constraints which are part of the given multi-value constraint.
private <A extends Annotation> List<ConstraintValidatorDescriptor<A>>	Returns: A list with the default validators as retrieved from `Constraint#validatedBy()` or the list of validators for built-in constraints. getDefaultValidatorDescriptors(Class<A> The constraint annotation type. annotationType) Returns the default validators for the given constraint type.
private boolean	isBuiltinConstraint(Class<? extends Annotation> annotationType)
private static boolean	isClassPresent(String className)
public boolean	Returns: `true` if the annotation fulfills the above conditions, `false` otherwise. isConstraintAnnotation(Class<? extends Annotation> The annotation type to test. annotationType) Checks whether the specified annotation is a valid constraint annotation.
public boolean	isConstraintComposition(Class<? extends Annotation> annotationType)
private boolean	isJavaMoneyInClasspath()
public boolean	isJdkAnnotation(Class<? extends Annotation> annotation)
private boolean	isJodaTimeInClasspath()
public boolean	Returns: `true` if the specified annotation is a multi value constraints, `false` otherwise. isMultiValueConstraint(Class<? extends Annotation> the annotation type to check. annotationType) Checks whether a given annotation is a multi value constraint or not.
private static <A extends Annotation> void	putBuiltinConstraint(Map<Class<? extends Annotation>, List<ConstraintValidatorDescriptor<?>>> validators, Class<A> constraintType)
private static <A extends Annotation> void	putBuiltinConstraint(Map<Class<? extends Annotation>, List<ConstraintValidatorDescriptor<?>>> validators, Class<A> constraintType, Class<? extends ConstraintValidator<A, ?>> validatorType)
private static <A extends Annotation> void	putBuiltinConstraints(Map<Class<? extends Annotation>, List<ConstraintValidatorDescriptor<?>>> validators, Class<A> constraintType, List<Class<? extends ConstraintValidator<A, ?>>> validatorTypes)
public < the type of the annotation A extends Annotation> void	putValidatorDescriptors(Class<A> The constraint annotation type annotationType, List<ConstraintValidatorDescriptor<A>> The validator descriptors to register validatorDescriptors, boolean Whether already-registered validators should be kept or not keepExistingClasses) Registers the given validator descriptors with the given constraint annotation type.
private static <T> T	run(PrivilegedAction<T> action) Runs the given privileged action, using a privileged block if required.
private boolean	supportsValidationTarget(ConstraintValidatorDescriptor<?> validatorDescriptor, ValidationTarget target)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

enabledBuiltinConstraints	back to summary
private final Map<Class<? extends Annotation>, List<? extends ConstraintValidatorDescriptor<?>>> enabledBuiltinConstraints Annotations @Immutable

externalConstraints	back to summary
private final ConcurrentMap<Class<? extends Annotation>, Boolean> externalConstraints

GROUPS	back to summary
public static final String GROUPS

JAVA_MONEY_CLASS_NAME	back to summary
private static final String JAVA_MONEY_CLASS_NAME

javaMoneyInClasspath	back to summary
private Boolean javaMoneyInClasspath

JODA_TIME_CLASS_NAME	back to summary
private static final String JODA_TIME_CLASS_NAME

jodaTimeInClassPath	back to summary
private Boolean jodaTimeInClassPath

LOG	back to summary
private static final Log LOG

MESSAGE	back to summary
public static final String MESSAGE

multiValueConstraints	back to summary
private final ConcurrentMap<Class<? extends Annotation>, Boolean> multiValueConstraints

PAYLOAD	back to summary
public static final String PAYLOAD

SUPPORTED_VALID_METHODS	back to summary
private static final List<String> SUPPORTED_VALID_METHODS

VALIDATION_APPLIES_TO	back to summary
public static final String VALIDATION_APPLIES_TO

validatorDescriptors	back to summary
private final ConstraintHelper.ValidatorDescriptorMap validatorDescriptors

Constructor Detail

ConstraintHelper	back to summary
private ConstraintHelper(Set<BuiltinConstraint> enabledBuiltinConstraints) Annotations @SuppressWarnings:deprecation

Method Detail

assertGroupsParameterExists	back to summary
private void assertGroupsParameterExists(Class<? extends Annotation> annotationType)

assertMessageParameterExists	back to summary
private void assertMessageParameterExists(Class<? extends Annotation> annotationType)

assertNoParameterStartsWithValid	back to summary
private void assertNoParameterStartsWithValid(Class<? extends Annotation> annotationType)

assertPayloadParameterExists	back to summary
private void assertPayloadParameterExists(Class<? extends Annotation> annotationType)

assertValidationAppliesToParameterSetUpCorrectly	back to summary
private void assertValidationAppliesToParameterSetUpCorrectly(Class<? extends Annotation> annotationType)

clear	back to summary
public void clear()

findValidatorDescriptors	back to summary
public <A extends Annotation> List<ConstraintValidatorDescriptor<A>> findValidatorDescriptors(Class<A> annotationType, ValidationTarget validationTarget) Returns those validator descriptors for the given constraint annotation matching the given target. Parameters <A> the type of the annotation annotationType:Class<A> The annotation of interest. validationTarget:ValidationTarget The target, either annotated element or parameters. Returns:List<ConstraintValidatorDescriptor<A>> A list with matching validator descriptors.

findValidatorDescriptors

back to summary

public <A extends Annotation> List<ConstraintValidatorDescriptor<A>> findValidatorDescriptors(Class<A> annotationType, ValidationTarget validationTarget)

Returns those validator descriptors for the given constraint annotation matching the given target.

Parameters

<A>: the type of the annotation
annotationType:Class<A>: The annotation of interest.
validationTarget:ValidationTarget: The target, either annotated element or parameters.

Returns:List<ConstraintValidatorDescriptor<A>>

A list with matching validator descriptors.

forAllBuiltinConstraints	back to summary
public static ConstraintHelper forAllBuiltinConstraints()

forBuiltinConstraints	back to summary
public static ConstraintHelper forBuiltinConstraints(Set<String> enabledConstraints)

getAllValidatorDescriptors back to summary

getAllValidatorDescriptors	back to summary
public <A extends Annotation> List<ConstraintValidatorDescriptor<A>> getAllValidatorDescriptors(Class<A> annotationType) Returns the constraint validator classes for the given constraint annotation type, as retrieved from `Constraint#validatedBy()`, internally registered validators for built-in constraints XML configuration and programmatically registered validators (see `org.hibernate.validator.cfg.ConstraintMapping#constraintDefinition(Class)`). The result is cached internally. Parameters <A> the type of the annotation annotationType:Class<A> The constraint annotation type. Returns:List<ConstraintValidatorDescriptor<A>> The validator classes for the given type.

public <A extends Annotation> List<ConstraintValidatorDescriptor<A>> getAllValidatorDescriptors(Class<A> annotationType)

Returns the constraint validator classes for the given constraint annotation type, as retrieved from

Constraint#validatedBy(),
internally registered validators for built-in constraints
XML configuration and
programmatically registered validators (see org.hibernate.validator.cfg.ConstraintMapping#constraintDefinition(Class)).

The result is cached internally.

Parameters

<A>: the type of the annotation
annotationType:Class<A>: The constraint annotation type.

Returns:List<ConstraintValidatorDescriptor<A>>

The validator classes for the given type.

getBuiltinConstraints	back to summary
public static Set<String> getBuiltinConstraints()

getConstraintsFromMultiValueConstraint back to summary

getConstraintsFromMultiValueConstraint	back to summary
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. Parameters <A> the type of the annotation multiValueConstraint:A the multi-value constraint annotation from which to retrieve the contained constraints Returns:List<Annotation> A list of constraint annotations, may be empty but never `null`.

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.

Parameters

<A>: the type of the annotation
multiValueConstraint:A: the multi-value constraint annotation from which to retrieve the contained constraints

Returns:List<Annotation>

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

getDefaultValidatorDescriptors back to summary

getDefaultValidatorDescriptors	back to summary
private <A extends Annotation> List<ConstraintValidatorDescriptor<A>> getDefaultValidatorDescriptors(Class<A> annotationType) Returns the default validators for the given constraint type. Parameters annotationType:Class<A> The constraint annotation type. Returns:List<ConstraintValidatorDescriptor<A>> A list with the default validators as retrieved from `Constraint#validatedBy()` or the list of validators for built-in constraints. Annotations @SuppressWarnings:unchecked

private <A extends Annotation> List<ConstraintValidatorDescriptor<A>> getDefaultValidatorDescriptors(Class<A> annotationType)

Returns the default validators for the given constraint type.

Parameters

annotationType:Class<A>: The constraint annotation type.

Returns:List<ConstraintValidatorDescriptor<A>>

A list with the default validators as retrieved from Constraint#validatedBy() or the list of validators for built-in constraints.

Annotations

@SuppressWarnings:unchecked

isBuiltinConstraint	back to summary
private boolean isBuiltinConstraint(Class<? extends Annotation> annotationType)

isClassPresent	back to summary
private static boolean isClassPresent(String className)

isConstraintAnnotation back to summary

isConstraintAnnotation	back to summary
public boolean isConstraintAnnotation(Class<? extends Annotation> annotationType) Checks whether the specified annotation is a valid constraint annotation. A constraint annotation has to fulfill the following conditions: Must be annotated with `Constraint` Define a message parameter Define a group parameter Define a payload parameter Parameters annotationType:Class<? extends Annotation> The annotation type to test. Returns:boolean `true` if the annotation fulfills the above conditions, `false` otherwise.

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

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

Must be annotated with Constraint
Define a message parameter
Define a group parameter
Define a payload parameter

Parameters

annotationType:Class<? extends Annotation>: The annotation type to test.

Returns:boolean

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

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

isJavaMoneyInClasspath	back to summary
private boolean isJavaMoneyInClasspath()

isJdkAnnotation	back to summary
public boolean isJdkAnnotation(Class<? extends Annotation> annotation)

isJodaTimeInClasspath	back to summary
private boolean isJodaTimeInClasspath()

isMultiValueConstraint back to summary

isMultiValueConstraint	back to summary
public boolean isMultiValueConstraint(Class<? extends Annotation> annotationType) Checks whether a given annotation is a multi value constraint or not. Parameters annotationType:Class<? extends Annotation> the annotation type to check. Returns:boolean `true` if the specified annotation is a multi value constraints, `false` otherwise.

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

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

Parameters

annotationType:Class<? extends Annotation>: the annotation type to check.

Returns:boolean

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

putBuiltinConstraint	back to summary
private static <A extends Annotation> void putBuiltinConstraint(Map<Class<? extends Annotation>, List<ConstraintValidatorDescriptor<?>>> validators, Class<A> constraintType)

putBuiltinConstraint	back to summary
private static <A extends Annotation> void putBuiltinConstraint(Map<Class<? extends Annotation>, List<ConstraintValidatorDescriptor<?>>> validators, Class<A> constraintType, Class<? extends ConstraintValidator<A, ?>> validatorType)

putBuiltinConstraints	back to summary
private static <A extends Annotation> void putBuiltinConstraints(Map<Class<? extends Annotation>, List<ConstraintValidatorDescriptor<?>>> validators, Class<A> constraintType, List<Class<? extends ConstraintValidator<A, ?>>> validatorTypes)

putValidatorDescriptors	back to summary
public <A extends Annotation> void putValidatorDescriptors(Class<A> annotationType, List<ConstraintValidatorDescriptor<A>> validatorDescriptors, boolean keepExistingClasses) Registers the given validator descriptors with the given constraint annotation type. Parameters <A> the type of the annotation annotationType:Class<A> The constraint annotation type validatorDescriptors:List<ConstraintValidatorDescriptor<A>> The validator descriptors to register keepExistingClasses:boolean Whether already-registered validators should be kept or not

putValidatorDescriptors

back to summary

public <A extends Annotation> void putValidatorDescriptors(Class<A> annotationType, List<ConstraintValidatorDescriptor<A>> validatorDescriptors, boolean keepExistingClasses)

Registers the given validator descriptors with the given constraint annotation type.

Parameters

<A>: the type of the annotation
annotationType:Class<A>: The constraint annotation type
validatorDescriptors:List<ConstraintValidatorDescriptor<A>>: The validator descriptors to register
keepExistingClasses:boolean: Whether already-registered validators should be kept or not

run	back to summary
private static <T> T run(PrivilegedAction<T> action) Runs the given privileged action, using a privileged block if required. Note This must never be changed into a publicly available method to avoid execution of arbitrary privileged actions within HV's protection domain. Annotations @IgnoreForbiddenApisErrors reason:SecurityManager is deprecated in JDK17

run

back to summary

private static <T> T run(PrivilegedAction<T> action)

Runs the given privileged action, using a privileged block if required.

Note

This must never be changed into a publicly available method to avoid execution of arbitrary privileged actions within HV's protection domain.

Annotations

@IgnoreForbiddenApisErrors
reason:SecurityManager is deprecated in JDK17

supportsValidationTarget	back to summary
private boolean supportsValidationTarget(ConstraintValidatorDescriptor<?> validatorDescriptor, ValidationTarget target)

org.hibernate.validator.internal.metadata.core back to summary

private Class ConstraintHelper.ValidatorDescriptorMap

Class Inheritance

extends Object

java.lang.Object
org.hibernate.validator.internal.metadata.core.ConstraintHelper.ValidatorDescriptorMap

Annotations

@SuppressWarnings:unchecked

A type-safe wrapper around a concurrent map from constraint types to associated validator classes. The casts are safe as data is added trough the typed API only.

Author: Gunnar Morling

Field Summary

Modifier and Type	Field and Description
private final ConcurrentMap<Class<? extends Annotation>, List<? extends ConstraintValidatorDescriptor<?>>>	constraintValidatorDescriptors

Constructor Summary

Access	Constructor and Description
private	ValidatorDescriptorMap()

Method Summary

Modifier and Type	Method and Description
private <A extends Annotation> List<ConstraintValidatorDescriptor<A>>	computeIfAbsent(Class<A> annotationType, Function<? super Class<A>, List<ConstraintValidatorDescriptor<A>>> mappingFunction)
private <A extends Annotation> void	put(Class<A> annotationType, List<ConstraintValidatorDescriptor<A>> validatorDescriptors)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

constraintValidatorDescriptors	back to summary
private final ConcurrentMap<Class<? extends Annotation>, List<? extends ConstraintValidatorDescriptor<?>>> constraintValidatorDescriptors

Constructor Detail

ValidatorDescriptorMap	back to summary
private ValidatorDescriptorMap()

Method Detail

computeIfAbsent	back to summary
private <A extends Annotation> List<ConstraintValidatorDescriptor<A>> computeIfAbsent(Class<A> annotationType, Function<? super Class<A>, List<ConstraintValidatorDescriptor<A>>> mappingFunction)

put	back to summary
private <A extends Annotation> void put(Class<A> annotationType, List<ConstraintValidatorDescriptor<A>> validatorDescriptors)

public Class ConstraintHelper

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class ConstraintHelper.ValidatorDescriptorMap

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail