• Home
• jakarta.platform
• jakarta.jakartaee-web-api
• 9.1.0
• source code
• ClockProvider.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

jakarta.validation.ClockProvider Maven / Gradle / Ivy

/*
 * Jakarta Bean Validation API
 *
 * License: Apache License, Version 2.0
 * See the license.txt file in the root directory or .
 */
package jakarta.validation;

import java.time.Clock;

/**
 * Contract for obtaining the {@link Clock} used as the reference for {@code now} when
 * validating the {@code @Future} and {@code @Past} constraints.
 * 

 * The default implementation will return the current system time. Plugging in custom
 * implementations may be useful for instance in batch applications which need to run with a
 * specific logical date, e.g. with yesterday's date when re-running a failed batch job
 * execution.
 * 

 * Implementations must be safe for access from several threads at the same time.
 *
 * @author Gunnar Morling
 * @author Guillaume Smet
 * @since 2.0
 */
public interface ClockProvider {

	/**
	 * Returns the clock which serves as the reference for {@code now}.
	 *
	 * @return the clock which serves as the reference for {@code now}; must not be
	 * {@code null}
	 */
	Clock getClock();
}