org.corfudb.util

Enum Sleep

java.lang.Object

java.lang.Enum<Sleep>

org.corfudb.util.Sleep

All Implemented Interfaces:

Serializable, Comparable<Sleep>

public enum Sleep
extends Enum<Sleep>

Utils for sleeping with or without interruptions using timeunits, much like TimeUnit's sleep functionality. Use these methods rather than Thread.sleep(long) or TimeUnit.sleep(long) because they handle properly.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DAYS
HOURS
MICROSECONDS
MILLISECONDS
MINUTES
NANOSECONDS
SECONDS

Method Summary

Modifier and Type	Method and Description
void	sleepRecoverably(long duration) Sleep, throwing an InterruptedException if the sleep is interrupted, re-setting the interrupted flag.
static void	sleepUninterruptibly(Duration duration) Sleep, without recovery logic in case the sleep is interrupted.
void	sleepUninterruptibly(long duration) Sleep, without recovery logic in case the sleep is interrupted.
static Sleep	valueOf(String name) Returns the enum constant of this type with the specified name.
static Sleep[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NANOSECONDS

public static final Sleep NANOSECONDS

MICROSECONDS

public static final Sleep MICROSECONDS

MILLISECONDS

public static final Sleep MILLISECONDS

SECONDS

public static final Sleep SECONDS

MINUTES

public static final Sleep MINUTES

HOURS

public static final Sleep HOURS

DAYS

public static final Sleep DAYS

Method Detail

values

public static Sleep[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Sleep c : Sleep.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Sleep valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

sleepUninterruptibly

public static void sleepUninterruptibly(Duration duration)

Sleep, without recovery logic in case the sleep is interrupted.

If sleep is interrupted, this method will throw UnrecoverableCorfuInterruptedError, which will indicate that Corfu was interrupted but cannot recover from the interruption.

Parameters:

duration - The duration to sleep.

sleepUninterruptibly

public void sleepUninterruptibly(long duration)

Sleep, without recovery logic in case the sleep is interrupted.

If sleep is interrupted, this method will throw UnrecoverableCorfuInterruptedError, which will indicate that Corfu was interrupted but cannot recover from the interruption.

Parameters:

duration - The duration to sleep.

sleepRecoverably

public void sleepRecoverably(long duration)
                      throws InterruptedException

Sleep, throwing an InterruptedException if the sleep is interrupted, re-setting the interrupted flag. If you call this method, you should cleanup state and exit the method you are currently running in, returning to the caller, by rethrowing the exception.

Parameters:

duration - The duration to sleep.

Throws:

InterruptedException