org.mycore.util.concurrent.MCRDelayedRunnable Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of mycore-base Show documentation
There is a newer version: 2024.05
/*
 * This file is part of ***  M y C o R e  ***
 * See http://www.mycore.de/ for details.
 *
 * MyCoRe is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * MyCoRe is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with MyCoRe.  If not, see .
 */

package org.mycore.util.concurrent;

import java.util.Objects;
import java.util.concurrent.Delayed;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicLong;

import com.google.common.primitives.Ints;

/**
 * Encapsulates a {@link Runnable} with in a object that can be fed into a
 * DelayQueue
 * 
 * Note: This class has a natural ordering that is inconsistent with equals.
 * Note: Two objects of this class are equal, if their ids are equal
 *       (other properties are ignored).
 * 
 * @author Robert Stephan
 *
 */
public class MCRDelayedRunnable implements Delayed, Runnable, MCRDecorator {

    private static AtomicLong ATOMIC_SYSTEM_TIME = new AtomicLong(System.currentTimeMillis());

    protected Runnable runnable;

    private long startTimeInMs = -1;

    private String id;

    /**
     * Creates a new {@link MCRDelayedRunnable} encapsulating a Runnable for delayed execution.
     * 
     * @param id, - the id of the runnable (used for equals-check)
     * @param delayInMs - the time in (ms) the task should be delayed
     * @param runnable the runnable to execute within a session and transaction
     */
    public MCRDelayedRunnable(String id, long delayInMs, Runnable runnable) {
        this.id = id;
        this.runnable = Objects.requireNonNull(runnable, "runnable must not be null");

        long current = ATOMIC_SYSTEM_TIME.accumulateAndGet(System.currentTimeMillis(), (x, y) -> Math.max(x + 1, y));
        startTimeInMs = current + delayInMs;
    }

    @Override
    public void run() {
        this.runnable.run();
    }

    @Override
    public Runnable get() {
        return this.runnable;
    }

    public String getId() {
        return id;
    }

    /**
     * order objects by their startTime
     */
    @Override
    public int compareTo(Delayed o) {
        return Ints.saturatedCast(this.startTimeInMs - ((MCRDelayedRunnable) o).startTimeInMs);
    }

    @Override
    public long getDelay(TimeUnit unit) {
        long diff = startTimeInMs - System.currentTimeMillis();
        return unit.convert(diff, TimeUnit.MILLISECONDS);
    }

    @Override
    public int hashCode() {
        final int prime = 31;
        int result = 1;
        result = prime * result + Objects.hash(id);
        return result;
    }

    /**
     * two objects are equal, if they have the same id
     */
    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null) {
            return false;
        }
        if (getClass() != obj.getClass()) {
            return false;
        }
        MCRDelayedRunnable other = (MCRDelayedRunnable) obj;
        return Objects.equals(id, other.id);
    }

}