jalse.actions

Class DefaultActionScheduler<T>

java.lang.Object

jalse.actions.DefaultActionScheduler<T>

Type Parameters:

T - Actor type.

All Implemented Interfaces:

ActionScheduler<T>

public class DefaultActionScheduler<T>
extends java.lang.Object
implements ActionScheduler<T>

A ActionScheduler implementation that schedules all actions against the supplied actor. Weak references are kept against all scheduled tasks so they can be bulk cancelled (these are also cleared on ActionEngine change).

By default if no ActionEngine is supplied ForkJoinActionEngine.commonPoolEngine() will be used.

Constructor Summary

Constructors

Constructor and Description
DefaultActionScheduler(T actor) Creates a DefaultScheduler for the supplied actor.

Method Summary

Modifier and Type	Method and Description
void	cancelAllScheduledForActor() Cancel all tasks scheduled to the current engine for the actor by this scheduler.
T	getActor() Gets the action Actor.
ActionEngine	getEngine() Gets the associated engine.
SchedulableActionContext<T>	newContextForActor(Action<T> action) Creates a new mutable context for the supplied action and this actor.
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.
void	setEngine(ActionEngine engine) Associates a engine to this scheduler (if the engine changes all task references are lost).

Methods inherited from class java.lang.Object

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

Methods inherited from interface jalse.actions.ActionScheduler

scheduleForActor, scheduleForActor

Constructor Detail

DefaultActionScheduler

public DefaultActionScheduler(T actor)

Creates a DefaultScheduler for the supplied actor.

Parameters:

actor - Actor to schedule actions against.

Method Detail

cancelAllScheduledForActor

public void cancelAllScheduledForActor()

Cancel all tasks scheduled to the current engine for the actor by this scheduler.

Specified by:

cancelAllScheduledForActor in interface ActionScheduler<T>

getActor

public T getActor()

Gets the action Actor.

Returns:

Actor to schedule events against.

getEngine

public ActionEngine getEngine()

Gets the associated engine.

Returns:

Associated engine or null if it has not been set.

newContextForActor

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

Description copied from interface: ActionScheduler

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

Specified by:

newContextForActor in interface ActionScheduler<T>

Parameters:

action - Action to create context for.

Returns:

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

scheduleForActor

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

Description copied from interface: ActionScheduler

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

Specified by:

scheduleForActor in interface ActionScheduler<T>

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).

setEngine

public void setEngine(ActionEngine engine)

Associates a engine to this scheduler (if the engine changes all task references are lost).

Parameters:

engine - Engine to schedule actions against.