
it.tidalwave.util.InstantProvider Maven / Gradle / Ivy
/*
* #%L
* *********************************************************************************************************************
*
* These Foolish Things - Miscellaneous utilities
* http://thesefoolishthings.tidalwave.it - git clone git@bitbucket.org:tidalwave/thesefoolishthings-src.git
* %%
* Copyright (C) 2009 - 2016 Tidalwave s.a.s. (http://tidalwave.it)
* %%
* *********************************************************************************************************************
*
* 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
*
* http://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.
*
* *********************************************************************************************************************
*
* $Id$
*
* *********************************************************************************************************************
* #L%
*/
package it.tidalwave.util;
import javax.annotation.Nonnull;
import java.time.Instant;
import java.util.function.Supplier;
import it.tidalwave.util.spi.DefaultInstantProvider;
import it.tidalwave.util.spi.MockInstantProvider;
/***********************************************************************************************************************
*
* A provider of {@link Instant}s. It should be used by code requiring a timestamp, so it can be mocked during tests.
* {@link DefaultInstantProvider} provides a default implementation, while {@link MockInstantProvider} is the one for
* tests.
*
* @see DefaultInstantProvider
* @see MockInstantProvider
* @author Fabrizio Giudici
* @version $Id$
* @since 1.39
*
**********************************************************************************************************************/
public interface InstantProvider extends Supplier
{
@Nonnull
public Instant getInstant();
@Override @Nonnull
default public Instant get()
{
return getInstant();
}
}