Top Fields Constructors Methods
org.hibernate.validator.internal.engine

public Class ValidatorContextImpl

extends Object
implements HibernateValidatorContext
Class Inheritance
All Implemented Interfaces
org.hibernate.validator.HibernateValidatorContext, jakarta.validation.ValidatorContext
Imports
java.lang.invoke.MethodHandles, java.time.Duration, java.util.HashMap, .Map, jakarta.validation.ClockProvider, .ConstraintValidatorFactory, .MessageInterpolator, .ParameterNameProvider, .TraversableResolver, .Validator, jakarta.validation.valueextraction.ValueExtractor, org.hibernate.validator.HibernateValidatorContext, org.hibernate.validator.internal.engine.valueextraction.ValueExtractorDescriptor, .ValueExtractorManager, org.hibernate.validator.internal.util.logging.Log, .LoggerFactory
Authors
Emmanuel Bernard, Hardy Ferentschik, Kevin Pollet <[email protected]> (C) 2011 SERLI, Gunnar Morling, Chris Beckey <[email protected]>

Field Summary

Modifier and TypeField and Description
private final ConstraintCreationContext
constraintCreationContext

private ConstraintValidatorFactory
constraintValidatorFactory

private static final Log
LOG

private final MethodValidationConfiguration.Builder
methodValidationConfigurationBuilder

private final ValidatorFactoryImpl
validatorFactory

private final ValidatorFactoryScopedContext.Builder
validatorFactoryScopedContextBuilder

private final Map<ValueExtractorDescriptor.Key, ValueExtractorDescriptor>
valueExtractorDescriptors

Constructor Summary

AccessConstructor and Description
public
ValidatorContextImpl(ValidatorFactoryImpl validatorFactory)

Method Summary

Modifier and TypeMethod and Description
public HibernateValidatorContext
addValueExtractor(ValueExtractor<?>
value extractor implementation
extractor)

Implements org.hibernate.validator.HibernateValidatorContext.addValueExtractor.

Adds a value extractor to be used by the Validator.
public HibernateValidatorContext
allowMultipleCascadedValidationOnReturnValues(boolean
flag determining whether validation will allow multiple cascaded validation on return values.
allow)

Implements org.hibernate.validator.HibernateValidatorContext.allowMultipleCascadedValidationOnReturnValues.

Define whether more than one constraint on a return value may be marked for cascading validation are allowed.
public HibernateValidatorContext
allowOverridingMethodAlterParameterConstraint(boolean
flag determining whether validation will allow overriding to alter parameter constraints.
allow)

Implements org.hibernate.validator.HibernateValidatorContext.allowOverridingMethodAlterParameterConstraint.

Define whether overriding methods that override constraints should throw a ConstraintDefinitionException.
public HibernateValidatorContext
allowParallelMethodsDefineParameterConstraints(boolean
flag determining whether validation will allow parameter constraints in parallel hierarchies
allow)

Implements org.hibernate.validator.HibernateValidatorContext.allowParallelMethodsDefineParameterConstraints.

Define whether parallel methods that define constraints should throw a ConstraintDefinitionException.
public HibernateValidatorContext
clockProvider(ClockProvider
ClockProvider implementation
clockProvider)

Implements org.hibernate.validator.HibernateValidatorContext.clockProvider.

Defines the ClockProvider implementation used by the Validator.
public HibernateValidatorContext
constraintValidatorFactory(ConstraintValidatorFactory
the ConstraintValidatorFactory used by the Validator
factory)

Implements org.hibernate.validator.HibernateValidatorContext.constraintValidatorFactory.

Defines the constraint validator factory implementation used by the Validator.
public HibernateValidatorContext
constraintValidatorPayload(Object
the payload passed to constraint validators
dynamicPayload)

Implements org.hibernate.validator.HibernateValidatorContext.constraintValidatorPayload.

Define a payload passed to the constraint validators.
public HibernateValidatorContext
enableTraversableResolverResultCache(boolean
flag determining whether per validation call caching is enabled for TraversableResolver results.
enabled)

Implements org.hibernate.validator.HibernateValidatorContext.enableTraversableResolverResultCache.

Define whether the per validation call caching of TraversableResolver results is enabled.
public HibernateValidatorContext
failFast(boolean
true to enable fail fast, false otherwise.
failFast)

Implements org.hibernate.validator.HibernateValidatorContext.failFast.

En- or disables the fail fast mode.
public Validator
getValidator()

Implements jakarta.validation.ValidatorContext.getValidator.

Returns an initialized Validator instance respecting the defined state.
public HibernateValidatorContext
messageInterpolator(MessageInterpolator
the MessageInterpolator used by the Validator
messageInterpolator)

Implements org.hibernate.validator.HibernateValidatorContext.messageInterpolator.

Defines the message interpolator implementation used by the Validator.
public HibernateValidatorContext
parameterNameProvider(ParameterNameProvider
parameter name provider implementation.
parameterNameProvider)

Implements org.hibernate.validator.HibernateValidatorContext.parameterNameProvider.

Defines the parameter name provider implementation used by the Validator.
public HibernateValidatorContext
showValidatedValuesInTraceLogs(boolean
true to show the values at trace level, false otherwise.
enabled)

Implements org.hibernate.validator.HibernateValidatorContext.showValidatedValuesInTraceLogs.

Define whether values that are currently being validated should be part of the logging at trace level, or not.
public HibernateValidatorContext
temporalValidationTolerance(Duration
the tolerance
temporalValidationTolerance)

Implements org.hibernate.validator.HibernateValidatorContext.temporalValidationTolerance.

Define the temporal validation tolerance i.e. the acceptable margin of error when comparing date/time in temporal constraints.
public HibernateValidatorContext
traversableResolver(TraversableResolver
the TraversableResolver used by the Validator
traversableResolver)

Implements org.hibernate.validator.HibernateValidatorContext.traversableResolver.

Defines the traversable resolver implementation used by the Validator.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

constraintCreationContextback to summary
private final ConstraintCreationContext constraintCreationContext
constraintValidatorFactoryback to summary
private ConstraintValidatorFactory constraintValidatorFactory
LOGback to summary
private static final Log LOG
methodValidationConfigurationBuilderback to summary
private final MethodValidationConfiguration.Builder methodValidationConfigurationBuilder
validatorFactoryback to summary
private final ValidatorFactoryImpl validatorFactory
validatorFactoryScopedContextBuilderback to summary
private final ValidatorFactoryScopedContext.Builder validatorFactoryScopedContextBuilder
valueExtractorDescriptorsback to summary
private final Map<ValueExtractorDescriptor.Key, ValueExtractorDescriptor> valueExtractorDescriptors

Constructor Detail

ValidatorContextImplback to summary
public ValidatorContextImpl(ValidatorFactoryImpl validatorFactory)

Method Detail

addValueExtractorback to summary
public HibernateValidatorContext addValueExtractor(ValueExtractor<?> extractor)

Implements org.hibernate.validator.HibernateValidatorContext.addValueExtractor.

Doc from jakarta.validation.ValidatorContext.addValueExtractor.

Adds a value extractor to be used by the Validator. Has priority over any extractor for the same type and type parameter detected through the service loader, given in the XML configuration or configured for the validator factory.

Parameters
extractor:ValueExtractor<?>

value extractor implementation

Returns:HibernateValidatorContext

self following the chaining method pattern

Annotations
@Override
allowMultipleCascadedValidationOnReturnValuesback to summary
public HibernateValidatorContext allowMultipleCascadedValidationOnReturnValues(boolean allow)

Implements org.hibernate.validator.HibernateValidatorContext.allowMultipleCascadedValidationOnReturnValues.

Doc from org.hibernate.validator.HibernateValidatorContext.allowMultipleCascadedValidationOnReturnValues.

Define whether more than one constraint on a return value may be marked for cascading validation are allowed. The default value is false, i.e. do not allow.

See Section 4.5.5 of the JSR 380 specification, specifically 

"One must not mark a method return value for cascaded validation more than once in a line of a class hierarchy.
In other words, overriding methods on sub types (be it sub classes/interfaces or interface implementations)
cannot mark the return value for cascaded validation if the return value has already been marked on the
overridden method of the super type or interface."
Parameters
allow:boolean

flag determining whether validation will allow multiple cascaded validation on return values.

Returns:HibernateValidatorContext

this following the chaining method pattern

Annotations
@Override
allowOverridingMethodAlterParameterConstraintback to summary
public HibernateValidatorContext allowOverridingMethodAlterParameterConstraint(boolean allow)

Implements org.hibernate.validator.HibernateValidatorContext.allowOverridingMethodAlterParameterConstraint.

Doc from org.hibernate.validator.HibernateValidatorContext.allowOverridingMethodAlterParameterConstraint.

Define whether overriding methods that override constraints should throw a ConstraintDefinitionException. The default value is false, i.e. do not allow.

See Section 4.5.5 of the JSR 380 specification, specifically 

"In sub types (be it sub classes/interfaces or interface implementations), no parameter constraints may
be declared on overridden or implemented methods, nor may parameters be marked for cascaded validation.
This would pose a strengthening of preconditions to be fulfilled by the caller."
Parameters
allow:boolean

flag determining whether validation will allow overriding to alter parameter constraints.

Returns:HibernateValidatorContext

this following the chaining method pattern

Annotations
@Override
allowParallelMethodsDefineParameterConstraintsback to summary
public HibernateValidatorContext allowParallelMethodsDefineParameterConstraints(boolean allow)

Implements org.hibernate.validator.HibernateValidatorContext.allowParallelMethodsDefineParameterConstraints.

Doc from org.hibernate.validator.HibernateValidatorContext.allowParallelMethodsDefineParameterConstraints.

Define whether parallel methods that define constraints should throw a ConstraintDefinitionException. The default value is false, i.e. do not allow.

See Section 4.5.5 of the JSR 380 specification, specifically 

"If a sub type overrides/implements a method originally defined in several parallel types of the hierarchy
(e.g. two interfaces not extending each other, or a class and an interface not implemented by said class),
no parameter constraints may be declared for that method at all nor parameters be marked for cascaded validation.
This again is to avoid an unexpected strengthening of preconditions to be fulfilled by the caller."
Parameters
allow:boolean

flag determining whether validation will allow parameter constraints in parallel hierarchies

Returns:HibernateValidatorContext

this following the chaining method pattern

Annotations
@Override
clockProviderback to summary
public HibernateValidatorContext clockProvider(ClockProvider clockProvider)

Implements org.hibernate.validator.HibernateValidatorContext.clockProvider.

Doc from jakarta.validation.ValidatorContext.clockProvider.

Defines the ClockProvider implementation used by the Validator. If not set or if null is passed as a parameter, the clock provider of the ValidatorFactory is used.

Parameters
clockProvider:ClockProvider

ClockProvider implementation

Returns:HibernateValidatorContext

self following the chaining method pattern

Annotations
@Override
constraintValidatorFactoryback to summary
public HibernateValidatorContext constraintValidatorFactory(ConstraintValidatorFactory factory)

Implements org.hibernate.validator.HibernateValidatorContext.constraintValidatorFactory.

Doc from jakarta.validation.ValidatorContext.constraintValidatorFactory.

Defines the constraint validator factory implementation used by the Validator. If not set or if null is passed as a parameter, the constraint validator factory of the ValidatorFactory is used.

Parameters
factory:ConstraintValidatorFactory

the ConstraintValidatorFactory used by the Validator

Returns:HibernateValidatorContext

self following the chaining method pattern

Annotations
@Override
constraintValidatorPayloadback to summary
public HibernateValidatorContext constraintValidatorPayload(Object dynamicPayload)

Implements org.hibernate.validator.HibernateValidatorContext.constraintValidatorPayload.

Doc from org.hibernate.validator.HibernateValidatorContext.constraintValidatorPayload.

Define a payload passed to the constraint validators. If the method is called multiple times, only the payload passed last will be propagated.

Parameters
dynamicPayload:Object

the payload passed to constraint validators

Returns:HibernateValidatorContext

this following the chaining method pattern

Annotations
@Override
enableTraversableResolverResultCacheback to summary
public HibernateValidatorContext enableTraversableResolverResultCache(boolean enabled)

Implements org.hibernate.validator.HibernateValidatorContext.enableTraversableResolverResultCache.

Doc from org.hibernate.validator.HibernateValidatorContext.enableTraversableResolverResultCache.

Define whether the per validation call caching of TraversableResolver results is enabled. The default value is true, i.e. the caching is enabled.

This behavior was initially introduced to cache the JPATraversableResolver results but the map lookups it introduces can be counterproductive when the TraversableResolver calls are very fast.

Parameters
enabled:boolean

flag determining whether per validation call caching is enabled for TraversableResolver results.

Returns:HibernateValidatorContext

this following the chaining method pattern

Annotations
@Override
failFastback to summary
public HibernateValidatorContext failFast(boolean failFast)

Implements org.hibernate.validator.HibernateValidatorContext.failFast.

Doc from org.hibernate.validator.HibernateValidatorContext.failFast.

En- or disables the fail fast mode. When fail fast is enabled the validation will stop on the first constraint violation detected.

Parameters
failFast:boolean

true to enable fail fast, false otherwise.

Returns:HibernateValidatorContext

this following the chaining method pattern

Annotations
@Override
getValidatorback to summary
public Validator getValidator()

Implements jakarta.validation.ValidatorContext.getValidator.

Doc from jakarta.validation.ValidatorContext.getValidator.

Returns an initialized Validator instance respecting the defined state. Validator instances can be pooled and shared by the implementation.

Returns:Validator

contextualized Validator

Annotations
@Override
messageInterpolatorback to summary
public HibernateValidatorContext messageInterpolator(MessageInterpolator messageInterpolator)

Implements org.hibernate.validator.HibernateValidatorContext.messageInterpolator.

Doc from jakarta.validation.ValidatorContext.messageInterpolator.

Defines the message interpolator implementation used by the Validator.

If not set or if null is passed as a parameter, the message interpolator of the ValidatorFactory is used.

Parameters
messageInterpolator:MessageInterpolator

the MessageInterpolator used by the Validator

Returns:HibernateValidatorContext

self following the chaining method pattern

Annotations
@Override
parameterNameProviderback to summary
public HibernateValidatorContext parameterNameProvider(ParameterNameProvider parameterNameProvider)

Implements org.hibernate.validator.HibernateValidatorContext.parameterNameProvider.

Doc from jakarta.validation.ValidatorContext.parameterNameProvider.

Defines the parameter name provider implementation used by the Validator. If not set or if null is passed as a parameter, the parameter name provider of the ValidatorFactory is used.

Parameters
parameterNameProvider:ParameterNameProvider

parameter name provider implementation.

Returns:HibernateValidatorContext

self following the chaining method pattern

Annotations
@Override
showValidatedValuesInTraceLogsback to summary
public HibernateValidatorContext showValidatedValuesInTraceLogs(boolean enabled)

Implements org.hibernate.validator.HibernateValidatorContext.showValidatedValuesInTraceLogs.

Doc from org.hibernate.validator.HibernateValidatorContext.showValidatedValuesInTraceLogs.

Define whether values that are currently being validated should be part of the logging at trace level, or not.

Parameters
enabled:boolean

true to show the values at trace level, false otherwise.

Returns:HibernateValidatorContext

this following the chaining method pattern

Annotations
@Override
temporalValidationToleranceback to summary
public HibernateValidatorContext temporalValidationTolerance(Duration temporalValidationTolerance)

Implements org.hibernate.validator.HibernateValidatorContext.temporalValidationTolerance.

Doc from org.hibernate.validator.HibernateValidatorContext.temporalValidationTolerance.

Define the temporal validation tolerance i.e. the acceptable margin of error when comparing date/time in temporal constraints.

Parameters
temporalValidationTolerance:Duration

the tolerance

Returns:HibernateValidatorContext

this following the chaining method pattern

Annotations
@Override
traversableResolverback to summary
public HibernateValidatorContext traversableResolver(TraversableResolver traversableResolver)

Implements org.hibernate.validator.HibernateValidatorContext.traversableResolver.

Doc from jakarta.validation.ValidatorContext.traversableResolver.

Defines the traversable resolver implementation used by the Validator.

If not set or if null is passed as a parameter, the traversable resolver of the ValidatorFactory is used.

Parameters
traversableResolver:TraversableResolver

the TraversableResolver used by the Validator

Returns:HibernateValidatorContext

self following the chaining method pattern

Annotations
@Override