Top Description Inners Fields Constructors Methods
org.hibernate.validator.internal.cfg.context

pack-priv Class ConstraintDefinitionContextImpl<A extends java.lang.annotation.Annotation>

extends ConstraintContextImplBase
implements ConstraintDefinitionContext<A extends Annotation>
Class Inheritance
All Implemented Interfaces
org.hibernate.validator.cfg.context.ConstraintDefinitionContext, org.hibernate.validator.cfg.context.ConstraintMappingTarget, org.hibernate.validator.cfg.context.ConstraintDefinitionTarget, org.hibernate.validator.cfg.context.TypeTarget
Type Parameters
<A>
The constraint (i.e. annotation type) represented by this context.
Imports
java.lang.annotation.Annotation, java.util.HashSet, .Set, jakarta.validation.ConstraintValidator, org.hibernate.validator.cfg.context.ConstraintDefinitionContext, org.hibernate.validator.internal.engine.constraintdefinition.ConstraintDefinitionContribution, org.hibernate.validator.internal.engine.constraintvalidation.ConstraintValidatorDescriptor, org.hibernate.validator.internal.util.CollectionHelper
Constraint definition context which allows to configure the validators to be used for a constraint's validation.
Author
Yoann Rodiere

Nested and Inner Type Summary

Modifier and TypeClass and Description
private class
ConstraintDefinitionContextImpl.ConstraintValidatorDefinitionContextImpl<T>

Field Summary

Modifier and TypeField and Description
private final Class<A>
annotationType

private boolean
includeExistingValidators

private final Set<ConstraintValidatorDescriptor<A>>
validatorDescriptors

Inherited from org.hibernate.validator.internal.cfg.context.ConstraintContextImplBase:
mapping

Constructor Summary

AccessConstructor and Description
pack-priv
ConstraintDefinitionContextImpl(DefaultConstraintMapping mapping, Class<A> annotationType)

Method Summary

Modifier and TypeMethod and Description
pack-priv ConstraintDefinitionContribution<A>
build()

public ConstraintDefinitionContext<A>
includeExistingValidators(boolean
Whether or not to use already-mapped validators when validating this constraint.
includeExistingValidators)

Implements org.hibernate.validator.cfg.context.ConstraintDefinitionContext.includeExistingValidators.

Specifies whether validators already mapped to this constraint (i.e. defined in the annotation declaration through jakarta.validation.Constraint#validatedBy() or the validation engine defaults) should be included or not.
public ConstraintDefinitionContext<A>
validatedBy(Class<? extends ConstraintValidator<A, ?>>
The validator to add.
validator)

Implements org.hibernate.validator.cfg.context.ConstraintDefinitionContext.validatedBy.

Adds a new validator to validate this constraint.
public <T> ConstraintDefinitionContext.ConstraintValidatorDefinitionContext<A, T>
validateType(Class<T>
The type of the value to validate
type)

Implements org.hibernate.validator.cfg.context.ConstraintDefinitionContext.validateType.

Allows to configure a validation implementation using a Lambda expression or method reference.
Inherited from org.hibernate.validator.internal.cfg.context.ConstraintContextImplBase:
constraintDefinitiontype

Field Detail

annotationTypeback to summary
private final Class<A> annotationType
includeExistingValidatorsback to summary
private boolean includeExistingValidators
validatorDescriptorsback to summary
private final Set<ConstraintValidatorDescriptor<A>> validatorDescriptors

Constructor Detail

ConstraintDefinitionContextImplback to summary
pack-priv ConstraintDefinitionContextImpl(DefaultConstraintMapping mapping, Class<A> annotationType)

Method Detail

buildback to summary
pack-priv ConstraintDefinitionContribution<A> build()
Annotations
@SuppressWarnings:unchecked
includeExistingValidatorsback to summary
public ConstraintDefinitionContext<A> includeExistingValidators(boolean includeExistingValidators)

Implements org.hibernate.validator.cfg.context.ConstraintDefinitionContext.includeExistingValidators.

Doc from org.hibernate.validator.cfg.context.ConstraintDefinitionContext.includeExistingValidators.

Specifies whether validators already mapped to this constraint (i.e. defined in the annotation declaration through jakarta.validation.Constraint#validatedBy() or the validation engine defaults) should be included or not.

Parameters
includeExistingValidators:boolean

Whether or not to use already-mapped validators when validating this constraint.

Returns:ConstraintDefinitionContext<A>

This context for method chaining.

Annotations
@Override
validatedByback to summary
public ConstraintDefinitionContext<A> validatedBy(Class<? extends ConstraintValidator<A, ?>> validator)

Implements org.hibernate.validator.cfg.context.ConstraintDefinitionContext.validatedBy.

Doc from org.hibernate.validator.cfg.context.ConstraintDefinitionContext.validatedBy.

Adds a new validator to validate this constraint.

Parameters
validator:Class<? extends ConstraintValidator<A, ?>>

The validator to add.

Returns:ConstraintDefinitionContext<A>

This context for method chaining.

Annotations
@Override
validateTypeback to summary
public <T> ConstraintDefinitionContext.ConstraintValidatorDefinitionContext<A, T> validateType(Class<T> type)

Implements org.hibernate.validator.cfg.context.ConstraintDefinitionContext.validateType.

Doc from org.hibernate.validator.cfg.context.ConstraintDefinitionContext.validateType.

Allows to configure a validation implementation using a Lambda expression or method reference. Useful for simple validations without the need for accessing constraint properties or customization of error messages etc.

Parameters
type:Class<T>

The type of the value to validate

Returns:ConstraintDefinitionContext.ConstraintValidatorDefinitionContext<A, T>

This context for method chaining

Annotations
@Override
org.hibernate.validator.internal.cfg.context back to summary

private Class ConstraintDefinitionContextImpl.ConstraintValidatorDefinitionContextImpl<T>

extends Object
implements ConstraintDefinitionContext.ConstraintValidatorDefinitionContext<A extends Annotation, T>
Class Inheritance
  • java.lang.Object
  • org.hibernate.validator.internal.cfg.context.ConstraintDefinitionContextImpl.ConstraintValidatorDefinitionContextImpl
All Implemented Interfaces
org.hibernate.validator.cfg.context.ConstraintDefinitionContext.ConstraintValidatorDefinitionContext

Field Summary

Modifier and TypeField and Description
private final Class<T>
type

Constructor Summary

AccessConstructor and Description
public
ConstraintValidatorDefinitionContextImpl(Class<T> type)

Method Summary

Modifier and TypeMethod and Description
public ConstraintDefinitionContext<A>
with(ConstraintDefinitionContext.ValidationCallable<T> vc)

Implements org.hibernate.validator.cfg.context.ConstraintDefinitionContext.ConstraintValidatorDefinitionContext.with.

Applies the given Lambda expression or referenced method to values to be validated.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

typeback to summary
private final Class<T> type

Constructor Detail

ConstraintValidatorDefinitionContextImplback to summary
public ConstraintValidatorDefinitionContextImpl(Class<T> type)

Method Detail

withback to summary
public ConstraintDefinitionContext<A> with(ConstraintDefinitionContext.ValidationCallable<T> vc)

Implements org.hibernate.validator.cfg.context.ConstraintDefinitionContext.ConstraintValidatorDefinitionContext.with.

Doc from org.hibernate.validator.cfg.context.ConstraintDefinitionContext.ConstraintValidatorDefinitionContext.with.

Applies the given Lambda expression or referenced method to values to be validated. It is guaranteed that null is never passed to these expressions or methods.

Annotations
@Override