jalse.actions

Class AbstractFutureActionContext<T>

java.lang.Object

jalse.actions.AbstractFutureActionContext<T>

Type Parameters:

T - Actor type.

All Implemented Interfaces:

ActionBindings, ActionContext<T>, SchedulableActionContext<T>

Direct Known Subclasses:

ThreadPoolActionEngine.ThreadPoolContext

public abstract class AbstractFutureActionContext<T>
extends java.lang.Object

An abstract implementation of SchedulableActionContext that is designed to be used with ExecutorService. This is a convenience class for creating an ActionEngine.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractFutureActionContext(ActionEngine engine, Action<T> action) Creates a new instance of AbstractFutureActionContext with the supplied engine and action.
protected	AbstractFutureActionContext(ActionEngine engine, Action<T> action, ActionBindings sourceBindings) Creates a new instance of AbstractFutureActionContext with the supplied engine, action and source bindings.

Method Summary

Modifier and Type	Method and Description
void	await() Awaits the execution (or cancellation of the action).
boolean	cancel() Cancels the associated action.
<S> S	get(java.lang.String key) Gets the value bound to the supplied key.
Action<T>	getAction() Gets the action this context is for.
T	getActor() Gets the associated actor.
ActionEngine	getEngine() Gets the associated engine.
protected java.util.concurrent.Future<?>	getFuture() Gets the future associated to the action task.
long	getInitialDelay(java.util.concurrent.TimeUnit unit) Gets the initial delay.
long	getPeriod(java.util.concurrent.TimeUnit unit) Gets the actions repeat period.
boolean	isCancelled() Whether the action has been cancelled.
boolean	isDone() Whether the action has been ran (or cancelled).
boolean	isPeriodicOnException() Whether the action will continue to reschedule on exception.
<S> S	put(java.lang.String key, S value) Binds the supplied key-value pair.
void	putAll(java.util.Map<java.lang.String,?> map) Binds all of the key-value pairs in the supplied map.
<S> S	remove(java.lang.String key) Removes the value bound to the supplied key.
void	removeAll() Removes all key-value pairs.
void	setActor(T actor) Sets the referenced actor.
protected void	setFuture(java.util.concurrent.Future<?> future) Sets the future of the associated action task.
void	setInitialDelay(long initialDelay, java.util.concurrent.TimeUnit unit) Sets the initial delay.
void	setPeriod(long period, java.util.concurrent.TimeUnit unit) Sets the period.
void	setPeriodicOnException(boolean periodicOnException) Sets whether the action continues to reschedule after an exception.
java.util.Map<java.lang.String,?>	toMap() Maps the key-values combinations.

Methods inherited from class java.lang.Object

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

Methods inherited from interface jalse.actions.SchedulableActionContext

schedule, scheduleAndAwait

Methods inherited from interface jalse.actions.ActionContext

getOptActor, hasActor, isPeriodic

Methods inherited from interface jalse.actions.ActionBindings

containsKey

Constructor Detail

AbstractFutureActionContext

protected AbstractFutureActionContext(ActionEngine engine,
                                      Action<T> action)

Creates a new instance of AbstractFutureActionContext with the supplied engine and action.

Parameters:

engine - Parent engine.

action - Action this context is for.

AbstractFutureActionContext

protected AbstractFutureActionContext(ActionEngine engine,
                                      Action<T> action,
                                      ActionBindings sourceBindings)

Creates a new instance of AbstractFutureActionContext with the supplied engine, action and source bindings.

Parameters:

engine - Parent engine.

action - The action this context is for.

sourceBindings - Bindings to shallow copy.

Method Detail

await

public void await()
           throws java.lang.InterruptedException

Description copied from interface: ActionContext

Awaits the execution (or cancellation of the action).

Throws:

java.lang.InterruptedException - If the current thread was interrupted.

cancel

public boolean cancel()

Description copied from interface: ActionContext

Cancels the associated action.

Returns:

Whether the action was cancelled.

getFuture

protected java.util.concurrent.Future<?> getFuture()

Gets the future associated to the action task.

Returns:

Future or null if none has been set.

isCancelled

public boolean isCancelled()

Description copied from interface: ActionContext

Whether the action has been cancelled.

Returns:

Cancelled state.

isDone

public boolean isDone()

Description copied from interface: ActionContext

Whether the action has been ran (or cancelled).

Returns:

Done state.

setFuture

protected void setFuture(java.util.concurrent.Future<?> future)

Sets the future of the associated action task.

Parameters:

future - Future to set.

get

public <S> S get(java.lang.String key)

Description copied from interface: ActionBindings

Gets the value bound to the supplied key.

Specified by:

get in interface ActionBindings

Parameters:

key - Key to check.

Returns:

Bound value or null if none found.

getAction

public Action<T> getAction()

Description copied from interface: SchedulableActionContext

Gets the action this context is for.

Specified by:

getAction in interface SchedulableActionContext<T>

Returns:

Action.

getActor

public T getActor()

Description copied from interface: ActionContext

Gets the associated actor.

Specified by:

getActor in interface ActionContext<T>

Returns:

The referenced actor or null if not found.

getEngine

public ActionEngine getEngine()

Description copied from interface: ActionContext

Gets the associated engine.

Specified by:

getEngine in interface ActionContext<T>

Returns:

Engine action is scheduled by from.

getInitialDelay

public long getInitialDelay(java.util.concurrent.TimeUnit unit)

Description copied from interface: SchedulableActionContext

Gets the initial delay.

Specified by:

getInitialDelay in interface SchedulableActionContext<T>

Parameters:

unit - TimeUnit to convert to.

Returns:

Initial delay in the supplied unit.

getPeriod

public long getPeriod(java.util.concurrent.TimeUnit unit)

Description copied from interface: ActionContext

Gets the actions repeat period.

Specified by:

getPeriod in interface ActionContext<T>

Parameters:

unit - TimeUnit to convert period to.

Returns:

Period in the supplied unit.

isPeriodicOnException

public boolean isPeriodicOnException()

Description copied from interface: ActionContext

Whether the action will continue to reschedule on exception.

Specified by:

isPeriodicOnException in interface ActionContext<T>

Returns:

Whether it continues when an exception is thrown.

put

public <S> S put(java.lang.String key,
                 S value)

Description copied from interface: ActionBindings

Binds the supplied key-value pair.

Specified by:

put in interface ActionBindings

Parameters:

key - Key to bind value to.

value - Value to bind.

Returns:

Previously associated value or null if none were.

putAll

public void putAll(java.util.Map<java.lang.String,?> map)

Description copied from interface: ActionBindings

Binds all of the key-value pairs in the supplied map.

Specified by:

putAll in interface ActionBindings

Parameters:

map - Key-value pairs to bind.

remove

public <S> S remove(java.lang.String key)

Description copied from interface: ActionBindings

Removes the value bound to the supplied key.

Specified by:

remove in interface ActionBindings

Parameters:

key - Key to check.

Returns:

Value that was bound to the key or else null if none were.

removeAll

public void removeAll()

Description copied from interface: ActionBindings

Removes all key-value pairs.

Specified by:

removeAll in interface ActionBindings

setActor

public void setActor(T actor)

Description copied from interface: SchedulableActionContext

Sets the referenced actor.

Specified by:

setActor in interface SchedulableActionContext<T>

Parameters:

actor - Actor.

setInitialDelay

public void setInitialDelay(long initialDelay,
                            java.util.concurrent.TimeUnit unit)

Description copied from interface: SchedulableActionContext

Sets the initial delay.

Specified by:

setInitialDelay in interface SchedulableActionContext<T>

Parameters:

initialDelay - Initial delay to set (can be 0).

unit - TimeUnit delay is in.

setPeriod

public void setPeriod(long period,
                      java.util.concurrent.TimeUnit unit)

Description copied from interface: SchedulableActionContext

Sets the period.

Specified by:

setPeriod in interface SchedulableActionContext<T>

Parameters:

period - Period to set (can be 0).

unit - TimeUnit period is in.

setPeriodicOnException

public void setPeriodicOnException(boolean periodicOnException)

Description copied from interface: SchedulableActionContext

Sets whether the action continues to reschedule after an exception.

Specified by:

setPeriodicOnException in interface SchedulableActionContext<T>

Parameters:

periodicOnException - Whether the action should continue.

toMap

public java.util.Map<java.lang.String,?> toMap()

Description copied from interface: ActionBindings

Maps the key-values combinations.

Specified by:

toMap in interface ActionBindings

Returns:

Map of bindings key-value combinations.