ikr.simlib.events

Interface EventToken

All Known Implementing Classes:

SimpleOrderedCalendar.Entry

public interface EventToken

Interface describing the object an entity gets when posting an event. This can be used to query the state of the event and to cancel the event.

At any point in time, exactly one of the methods isPending(), hasBeenCancelled(), or hasBeenExecuted() will return true.

Method Summary

Methods

Modifier and Type	Method and Description
void	cancel() Cancel the event, i.e.
boolean	hasBeenCancelled()
boolean	hasBeenExecuted()
boolean	isPending()

Method Detail

isPending

boolean isPending()

Returns:

true if the event (with the specified time of execution) is in the calendar, false if it has been executed or cancelled

hasBeenExecuted

boolean hasBeenExecuted()

Returns:

true if the event (with the specified time of execution) has been executed, false if it is still pending or has ben cancelled.

hasBeenCancelled

boolean hasBeenCancelled()

Returns:

true if the event (with the specified time of execution) has been cancelled, false if it has been executed or is still pending

cancel

void cancel()

Cancel the event, i.e. execute its onCancel method now, and do not execute it's onExecute method at the specified time of execution.