org.hibernate.validator.internal.constraintvalidators.bv.time

Class AbstractEpochBasedTimeValidator<C extends Annotation,T>

java.lang.Object

org.hibernate.validator.internal.constraintvalidators.bv.time.AbstractEpochBasedTimeValidator<C,T>

All Implemented Interfaces:

ConstraintValidator<C,T>, HibernateConstraintValidator<C,T>

Direct Known Subclasses:

AbstractFutureEpochBasedValidator, AbstractFutureOrPresentEpochBasedValidator, AbstractPastEpochBasedValidator, AbstractPastOrPresentEpochBasedValidator

public abstract class AbstractEpochBasedTimeValidator<C extends Annotation,T>
extends Object
implements HibernateConstraintValidator<C,T>

Base class for all time validators that use an epoch to be compared to the time reference.

Author:

Alaa Nassef, Guillaume Smet

Field Summary

Fields

Modifier and Type	Field and Description
protected Clock	referenceClock

Constructor Summary

Constructors

Constructor and Description
AbstractEpochBasedTimeValidator()

Method Summary

Modifier and Type	Method and Description
protected abstract Duration	getEffectiveTemporalValidationTolerance(Duration absoluteTemporalValidationTolerance) Returns the temporal validation tolerance to apply.
protected abstract long	getEpochMillis(T value, Clock reference) Returns the millisecond based instant measured from Epoch.
void	initialize(ConstraintDescriptor<C> constraintDescriptor, HibernateConstraintValidatorInitializationContext initializationContext) Initializes the validator in preparation for ConstraintValidator.isValid(Object, ConstraintValidatorContext) calls.
protected abstract boolean	isValid(int result) Returns whether the result of the comparison between the validated value and the time reference is considered valid.
boolean	isValid(T value, ConstraintValidatorContext context) Implements the validation logic.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.validation.ConstraintValidator

initialize

Field Detail

referenceClock

protected Clock referenceClock

Constructor Detail

AbstractEpochBasedTimeValidator

public AbstractEpochBasedTimeValidator()

Method Detail

initialize

public void initialize(ConstraintDescriptor<C> constraintDescriptor,
                       HibernateConstraintValidatorInitializationContext initializationContext)

Description copied from interface: HibernateConstraintValidator

Initializes the validator in preparation for ConstraintValidator.isValid(Object, ConstraintValidatorContext) calls. It is an alternative to ConstraintValidator.initialize(Annotation) method. Should be used if any additional information except annotation is needed to initialize a validator. Note, when using HibernateConstraintValidator user should only override one of the methods, either HibernateConstraintValidator.initialize(ConstraintDescriptor, HibernateConstraintValidatorInitializationContext) or ConstraintValidator.initialize(Annotation). Both methods will be called during initialization, starting with HibernateConstraintValidator.initialize(ConstraintDescriptor, HibernateConstraintValidatorInitializationContext).

Specified by:

initialize in interface HibernateConstraintValidator<C extends Annotation,T>

Parameters:

constraintDescriptor - a constraint descriptor for a given constraint declaration

initializationContext - an initialization context for a current ConstraintValidatorFactory

isValid

public boolean isValid(T value,
                       ConstraintValidatorContext context)

Description copied from interface: ConstraintValidator

Implements the validation logic. The state of value must not be altered.

This method can be accessed concurrently, thread-safety must be ensured by the implementation.

Specified by:

isValid in interface ConstraintValidator<C extends Annotation,T>

Parameters:

value - object to validate

context - context in which the constraint is evaluated

Returns:

false if value does not pass the constraint

getEffectiveTemporalValidationTolerance

protected abstract Duration getEffectiveTemporalValidationTolerance(Duration absoluteTemporalValidationTolerance)

Returns the temporal validation tolerance to apply.

getEpochMillis

protected abstract long getEpochMillis(T value,
                                       Clock reference)

Returns the millisecond based instant measured from Epoch. In the case of partials requiring a time reference, we use the Clock provided by the ClockProvider.

isValid

protected abstract boolean isValid(int result)

Returns whether the result of the comparison between the validated value and the time reference is considered valid.