com.ebay.lightning.core.async

Class Reminder

java.lang.Object

com.ebay.lightning.core.async.Reminder

public class Reminder
extends java.lang.Object

The Reminder class provides the helper functions to create one time or repeating reminders. The tasks for Reminder are defined by Callback

Author:

shashukla

See Also:

Callback

Constructor Summary

Constructors

Constructor and Description
Reminder(java.lang.String reminderName, Callback<?> callback, java.lang.Long freqInSeconds, boolean repeatForever) Construct an one-time or repeating reminder.

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancel the reminder
java.lang.String	getReminderName() Get the reminder name.

Methods inherited from class java.lang.Object

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

Constructor Detail

Reminder

public Reminder(java.lang.String reminderName,
                Callback<?> callback,
                java.lang.Long freqInSeconds,
                boolean repeatForever)

Construct an one-time or repeating reminder.

Parameters:

reminderName - the name of the reminder.

callback - the method to call for every execution of the reminder

freqInSeconds - frequency of the reminder execution

repeatForever - one-time or repeating task.

Method Detail

cancel

public void cancel()

Cancel the reminder

getReminderName

public java.lang.String getReminderName()

Get the reminder name.

Returns:

the reminder name