com.bluecatcode.common.concurrent.Sleep Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of guava-15.0-extended Show documentation

Guava library extensions.

There is a newer version: 1.1.0

package com.bluecatcode.common.concurrent;

import com.google.common.base.Optional;

import javax.annotation.WillCloseWhenClosed;
import javax.annotation.WillNotClose;
import java.util.concurrent.TimeUnit;

/**
 * Specialised sleep methods
 *
 * @see TimeUnit
 */
public class Sleep {

    /**
     * Interruptible sleep of the current thread
     *
     * Will interrupt the thread if InterruptedException occurs
     *
     * @param timeout with unit, the maximum length of time that callers are willing to wait
     * @param unit with timeout, the maximum length of time that callers are willing to wait
     *
     * @see TimeUnit#sleep(long)
     */
    @WillCloseWhenClosed
    public static void sleepFor(long timeout, TimeUnit unit) {
        try {
            unit.sleep(timeout);
        } catch (InterruptedException e) {
            Thread.currentThread().interrupt();
        }
    }

    /**
     * Uninterruptible sleep of the current thread
     *
     * WARNING: you must propagate the exception or interrupt the current thread
     *
     * @param timeout with unit, the maximum length of time that callers are willing to wait
     * @param unit with timeout, the maximum length of time that callers are willing to wait
     * @return true if was interrupted or false if not
     *
     * @see TimeUnit#sleep(long)
     */
    @WillNotClose
    public static Optional uninterruptibleSleepFor(long timeout, TimeUnit unit) {
        try {
            unit.sleep(timeout);
            return Optional.absent();
        } catch (InterruptedException e) {
            return Optional.of(e);
        }
    }
}