com.github.richardballard.arbeeutils.time.TimeTicks Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of arbee-utils Show documentation

A collection of utilities that I find useful across various projects

There is a newer version: 2.0

/*
 * (C) Copyright 2016 Richard Ballard.
 *
 * 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.
 */

package com.github.richardballard.arbeeutils.time;

import net.jcip.annotations.Immutable;
import org.jetbrains.annotations.NotNull;

import java.util.function.Supplier;

@Immutable
public enum TimeTicks {
    ;

    @NotNull
    private static final Supplier SYSTEM_CURRENT_TIME_TICK_SUPPLIER =
            () -> new TimeTick(System.nanoTime());

    /**
     * Returns a {@link Supplier} thats gives the current {@link TimeTick}.
     */
    @NotNull
    public static Supplier systemCurrentTimeTickSupplier() {
        return SYSTEM_CURRENT_TIME_TICK_SUPPLIER;
    }

    /**
     * This method is intended for tests where a known value must be used to make things deterministic
     */
    @NotNull
    public static TimeTick explicitTimeTick(final long nanoTicks) {
        return new TimeTick(nanoTicks);
    }
}