net.guizhanss.guizhanlib.common.Cooldown Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of GuizhanLib-api Show documentation

The newest version!

package net.guizhanss.guizhanlib.common;

import java.util.HashMap;
import java.util.Map;

/**
 * This class provides cooldown feature, based on keys.
 *
 * @param  The type of key.
 * @author ybw0014
 */
public final class Cooldown {
    /**
     * This map records when key is used.
     */
    private final Map useMap = new HashMap<>();
    /**
     * This map records the cooldown time/
     */
    private final Map timeMap = new HashMap<>();

    /**
     * Query if the key can be used.
     *
     * @param key The key.
     * @return Whether the key can be used.
     */
    public boolean check(K key) {
        Long lastUse = useMap.get(key);
        Long cdTime = timeMap.get(key);

        // Lack of record, this should not happen.
        if (lastUse == null || cdTime == null) {
            return true;
        }

        return System.nanoTime() - lastUse >= cdTime;
    }

    /**
     * Set cooldown of key.
     *
     * @param key  The key.
     * @param time The cooldown in milliseconds.
     */
    public void set(K key, long time) {
        useMap.put(key, System.nanoTime());
        timeMap.put(key, time * 1_000_000L);
    }
}