[core] Add javadoc to SmackReactor.cancel(ScheduledAction)

This commit is contained in:
Florian Schmaus 2020-05-16 14:16:05 +02:00
parent dfdd0acf91
commit 6daf19dbd3
1 changed files with 6 additions and 0 deletions

View File

@ -154,6 +154,12 @@ public class SmackReactor {
return scheduledAction;
}
/**
* Cancels the scheduled action.
*
* @param scheduledAction the scheduled action to cancel.
* @return <code>true</code> if the scheduled action was still pending and got removed, <code>false</code> otherwise.
*/
boolean cancel(ScheduledAction scheduledAction) {
return scheduledActions.remove(scheduledAction);
}