- All Superinterfaces:
TimerRef
- All Known Implementing Classes:
AgentTimer
Internal context that binds a
Timer
to a Schedule
.
A TimerContext
can be used by a Timer
to check its status,
to reschedule itself, and to cancel itself. TimerContext
is thread
safe.- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionboolean
cancel()
Cancels the timer to prevent it from executing.boolean
Returnstrue
if the timer is currently scheduled to execute.void
reschedule
(long millis) Schedules the timer to execute aftermillis
milliseconds has elapsed.schedule()
Returns theSchedule
to which the timer is bound.
-
Method Details
-
schedule
Schedule schedule()Returns theSchedule
to which the timer is bound. -
isScheduled
boolean isScheduled()Returnstrue
if the timer is currently scheduled to execute.- Specified by:
isScheduled
in interfaceTimerRef
-
reschedule
void reschedule(long millis) Schedules the timer to execute aftermillis
milliseconds has elapsed. If the timer is currently scheduled, it will not ececute at its previously scheduled time; it will only execute at the newly scheduled time.- Specified by:
reschedule
in interfaceTimerRef
- Throws:
TimerException
- ifmillis
is negative.
-
cancel
boolean cancel()Cancels the timer to prevent it from executing. Returnstrue
if this operation caused the cancellation of the timer; returnsfalse
if the timer was not scheduled to execute.
-