Package io.micronaut.validation.validator.constraints

Interface ConstraintValidatorContext

All Superinterfaces:
jakarta.validation.ConstraintValidatorContext
public interface ConstraintValidatorContext extends jakarta.validation.ConstraintValidatorContext
Subset of the ConstraintValidatorContext interface without the unnecessary parts.
Since:
1.2
Author:
graemerocher

  • Nested Class Summary

    Nested classes/interfaces inherited from interface jakarta.validation.ConstraintValidatorContext

    jakarta.validation.ConstraintValidatorContext.ConstraintViolationBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    @NonNull jakarta.validation.ClockProvider
    getClockProvider()
    Returns the provider for obtaining the current time in the form of a Clock, e.g.
    @Nullable Object
    getRootBean()
    In case of using this constraint validator with jakarta.validation.ConstraintValidator returns null, because JRS-303 doesn't support passing a root bean in their validation context.
    default void
    messageTemplate(@Nullable String messageTemplate)
    Sets a message template to be used for the validation error message.

    Methods inherited from interface jakarta.validation.ConstraintValidatorContext

    buildConstraintViolationWithTemplate, disableDefaultConstraintViolation, getDefaultConstraintMessageTemplate, unwrap

  • Method Details

    • getClockProvider

      @NonNull @NonNull jakarta.validation.ClockProvider getClockProvider()
      Returns the provider for obtaining the current time in the form of a Clock, e.g. when validating the Future and Past constraints.
      Specified by:
      getClockProvider in interface jakarta.validation.ConstraintValidatorContext
      Returns:
      the provider for obtaining the current time, never null. If no specific provider has been configured during bootstrap, a default implementation using the current system time and the current default time zone as returned by Clock.systemDefaultZone() will be returned.
      Since:
      2.0

    • getRootBean

      @Nullable @Nullable Object getRootBean()
      In case of using this constraint validator with jakarta.validation.ConstraintValidator returns null, because JRS-303 doesn't support passing a root bean in their validation context.
      Returns:
      The root bean under validation.

    • messageTemplate

      default void messageTemplate(@Nullable @Nullable String messageTemplate)
      Sets a message template to be used for the validation error message.
      Parameters:
      messageTemplate - the message template
      Since:
      2.5.0