/*
 * Copyright 2023-2024 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.springframework.modulith.moments.support;

import java.time.Instant;
import java.time.LocalDate;
import java.time.LocalDateTime;

/**
 * An abstraction of the current point in time and today. Useful if application code needs to look them up, but you need
 * a mechanism to shift the time for testing local development purposes.
 *
 * @author Oliver Drotbohm
 * @since 1.1
 * @see TimeMachine
 */
public interface Now {

	/**
	 * Returns the current point in time.
	 *
	 * @return will never be {@literal null}.
	 */
	LocalDateTime now();

	/**
	 * Returns the current date.
	 *
	 * @return will never be {@literal null}.
	 */
	LocalDate today();

	/**
	 * Returns the current Instant.
	 *
	 * @return will never be {@literal null}.
	 */
	Instant instant();
}
