org.rvpf.base.util

Class SnoozeAlarm

Object

SnoozeAlarm

@ThreadSafe
public final class SnoozeAlarm
extends Object

Snooze alarm.

Allows sleepy threads to take a nap until either a specified amount of time has elapsed or something happened that required everybody to wake up.

Each instance can control any number of threads. A wakeUp() call will affect all the threads snoozing on the same instance.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_MINIMUM_SNOOZE_MILLIS Minimum snooze time in milliseconds.
static String	MINIMUM_SNOOZE_MILLIS_PROPERTY Minimum snooze millis system property.

Constructor Summary

Constructors

Constructor and Description
SnoozeAlarm() Constructs an instance.
SnoozeAlarm(Optional<Object> sync) Constructs an instance.

Method Summary

Modifier and Type	Method and Description
void	close() Closes.
void	snooze() Snoozes until awoken.
boolean	snooze(ElapsedTime snoozeTime) Snoozes for the specified time.
boolean	snooze(Optional<DateTime> wakeTime) Snoozes until the specified time.
static boolean	validate(ElapsedTime time, Object caller, Messages.Entry nameEntry) Validates a snooze time.
void	wakeUp() Wakes up all snoozers.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_MINIMUM_SNOOZE_MILLIS

public static final String DEFAULT_MINIMUM_SNOOZE_MILLIS

Minimum snooze time in milliseconds.

See Also:

Constant Field Values

MINIMUM_SNOOZE_MILLIS_PROPERTY

public static final String MINIMUM_SNOOZE_MILLIS_PROPERTY

Minimum snooze millis system property.

See Also:

Constant Field Values

Constructor Detail

SnoozeAlarm

public SnoozeAlarm()

Constructs an instance.

SnoozeAlarm

public SnoozeAlarm(@Nonnull
                   Optional<Object> sync)

Constructs an instance.

This constructor allows the specification of a synchronization object (defaults to the created instance) to solve some deadlock problems.

Parameters:

sync - A sync object (when null, will be this).

Method Detail

validate

@CheckReturnValue
public static boolean validate(@Nonnull
                                                  ElapsedTime time,
                                                  @Nonnull
                                                  Object caller,
                                                  @Nonnull
                                                  Messages.Entry nameEntry)

Validates a snooze time.

Parameters:

time - The snooze time.

caller - The caller.

nameEntry - The entry for an identifying name for the error message.

Returns:

True if the snooze time is valid.

close

public void close()

Closes.

Also wakes up the snoozers.

snooze

public void snooze()
            throws InterruptedException

Snoozes until awoken.

Caution: calling this method while holding a lock other than the sync object supplied to the constructor might cause a stall.

Throws:

InterruptedException - When interrupted.

snooze

@CheckReturnValue
public boolean snooze(@Nonnull
                                         ElapsedTime snoozeTime)
                                  throws InterruptedException

Snoozes for the specified time.

Caution: calling this method while holding a lock other than the sync object supplied to the constructor might cause a stall.

Parameters:

snoozeTime - The snooze time.

Returns:

True when snooze time completed.

Throws:

InterruptedException - When interrupted.

snooze

@CheckReturnValue
public boolean snooze(@Nonnull
                                         Optional<DateTime> wakeTime)
                                  throws InterruptedException

Snoozes until the specified time.

Caution: calling this method while holding a lock other than the sync object supplied to the constructor may cause a stall.

Parameters:

wakeTime - The wake time (empty for infinite).

Returns:

True when snooze time completed.

Throws:

InterruptedException - When interrupted.

wakeUp

public void wakeUp()

Wakes up all snoozers.