jalse.actions

Interface ActionScheduler<T>

Type Parameters:

T - Actor type to schedule referencing work.

All Known Subinterfaces:

Entity, JALSE

All Known Implementing Classes:

DefaultActionScheduler, DefaultEntity, DefaultJALSE

public interface ActionScheduler<T>

This is the JALSE equivalent to Executor. Action can be scheduled to be run once now, in the future and periodically at an interval. When an action is run work can be performed using a supplied actor, scheduler defines the actor type as well as a means to maintain previously scheduled/running actions.

Method Summary

Modifier and Type	Method and Description
void	cancelAllScheduledForActor() Cancels all tasks currently running/scheduled (scheduled by this).
SchedulableActionContext<T>	newContextForActor(Action<T> action) Creates a new mutable context for the supplied action and this actor.
default ActionContext<T>	scheduleForActor(Action<T> action) Schedules an action for immediate execution.
ActionContext<T>	scheduleForActor(Action<T> action, long initialDelay, long period, java.util.concurrent.TimeUnit unit) Schedules an action for execution with a supplied initial delay and repeat period.
default ActionContext<T>	scheduleForActor(Action<T> action, long initialDelay, java.util.concurrent.TimeUnit unit) Schedules an action to be executed after the supplied delay.

Method Detail

cancelAllScheduledForActor

void cancelAllScheduledForActor()

Cancels all tasks currently running/scheduled (scheduled by this).

newContextForActor

SchedulableActionContext<T> newContextForActor(Action<T> action)

Creates a new mutable context for the supplied action and this actor.

Parameters:

action - Action to create context for.

Returns:

Context bound to the action and actor (immutable for actor).

scheduleForActor

default ActionContext<T> scheduleForActor(Action<T> action)

Schedules an action for immediate execution.

Parameters:

action - Action to schedule.

Returns:

Context associated with the action (immutable).

scheduleForActor

ActionContext<T> scheduleForActor(Action<T> action,
                                  long initialDelay,
                                  long period,
                                  java.util.concurrent.TimeUnit unit)

Schedules an action for execution with a supplied initial delay and repeat period.

Parameters:

action - Action to schedule.

initialDelay - Initial delay before schedule (can be 0).

period - Period for repeating (can be 0).

unit - Time unit of initial delay and period.

Returns:

Context associated with the action (immutable).

scheduleForActor

default ActionContext<T> scheduleForActor(Action<T> action,
                                          long initialDelay,
                                          java.util.concurrent.TimeUnit unit)

Schedules an action to be executed after the supplied delay.

Parameters:

action - Action to schedule.

initialDelay - Delay before schedule.

unit - TimeUnit of the delay.

Returns:

Context associated with the action (immutable).