com.vlkan.rfos.Clock Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rotating-fos Show documentation

Sneakily rotating your FileOutputStream since 2017.

There is a newer version: 0.10.0

/*
 * Copyright 2018-2022 Volkan Yazıcı
 *
 * 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 permits and
 * limitations under the License.
 */

package com.vlkan.rfos;

import java.time.Instant;

/**
 * The clock used by {@link RotatingFileOutputStream}.
 */
public interface Clock {

    /**
     * Gets the current instant.
     *
     * @return the current instant
     */
    Instant now();

    /**
     * Gets the instant of the upcoming midnight.
     *
     * @return the instant of the upcoming midnight
     */
    Instant midnight();

    /**
     * Gets the instant of the upcoming Sunday midnight.
     *
     * @return the instant of the upcoming Sunday midnight.
     */
    Instant sundayMidnight();

}