common/src/main/java/org/apache/cassandra/sidecar/common/utils/TimeUtils.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.apache.cassandra.sidecar.common.utils;

import java.time.Duration;
import java.util.concurrent.ThreadLocalRandom;

/**
 * Utility class for manipulating dates, times, and durations
 */
public final class TimeUtils
{
    /**
     * Private constructor that prevents unnecessary instantiation
     *
     * @throws IllegalStateException when called
     */
    private TimeUtils()
    {
        throw new IllegalStateException(getClass() + " is a static utility class and shall not be instantiated");
    }

    /**
     * Returns a random duration with millisecond precision that is uniformly distributed between two provided durations
     *
     * @param minimum minimum possible duration, inclusive
     * @param maximum maximum possible duration, inclusive
     *
     * @return random duration uniformly distributed between two provided durations, with millisecond precision
     *
     * @throws IllegalArgumentException if minimum duration is greater than maximum duration
     */
    public static Duration randomDuration(Duration minimum, Duration maximum)
    {
        Preconditions.checkArgument(minimum.compareTo(maximum) <= 0,
                                    "Minimum duration must be less or equal to maximum duration");
        return Duration.ofMillis(ThreadLocalRandom.current().nextLong(minimum.toMillis(), maximum.toMillis() + 1L));
    }
}