Package jakarta.validation

Interface ValidatorContext

public interface ValidatorContext
Represents the context that is used to create Validator instances. A client may use methods of the ValidatorContext returned by ValidatorFactory.usingContext() to customize the context used to create Validator instances (for instance establish different message interpolators or traversable resolvers).
Author:
Emmanuel Bernard, Gunnar Morling, Guillaume Smet

  • Method Details

    • messageInterpolator

      ValidatorContext messageInterpolator(MessageInterpolator 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 - the MessageInterpolator used by the Validator
      Returns:
      self following the chaining method pattern

    • traversableResolver

      ValidatorContext traversableResolver(TraversableResolver 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 - the TraversableResolver used by the Validator
      Returns:
      self following the chaining method pattern

    • constraintValidatorFactory

      ValidatorContext constraintValidatorFactory(ConstraintValidatorFactory factory)
      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 - the ConstraintValidatorFactory used by the Validator
      Returns:
      self following the chaining method pattern

    • parameterNameProvider

      ValidatorContext parameterNameProvider(ParameterNameProvider 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 - parameter name provider implementation.
      Returns:
      self following the chaining method pattern
      Since:
      1.1

    • clockProvider

      ValidatorContext clockProvider(ClockProvider 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 implementation
      Returns:
      self following the chaining method pattern
      Since:
      2.0

    • addValueExtractor

      ValidatorContext addValueExtractor(ValueExtractor<?> extractor)
      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 - value extractor implementation
      Returns:
      self following the chaining method pattern
      Throws:
      ValueExtractorDeclarationException - if more than one extractor for the same type and type parameter is added
      Since:
      2.0

    • getValidator

      Validator getValidator()
      Returns an initialized Validator instance respecting the defined state. Validator instances can be pooled and shared by the implementation.
      Returns:
      contextualized Validator