jalse.actions

Interface ActionEngine

All Known Subinterfaces:

JALSE

All Known Implementing Classes:

AbstractActionEngine, DefaultJALSE, ForkJoinActionEngine, ManualActionEngine, ThreadPoolActionEngine

public interface ActionEngine

An engine for scheduling Action for execution. Work can be scheduled immediately or with a given delay and can be periodic. This work can be tracked, cancelled and awaited.

See Also:

Action.perform(ActionContext), ForkJoinActionEngine, ThreadPoolActionEngine, ManualActionEngine

Method Summary

Modifier and Type	Method and Description
ActionBindings	getBindings() Bindings for this engine.
boolean	isPaused() Whether the engine is paused.
boolean	isStopped() Whether the engine is stopped.
<T> SchedulableActionContext<T>	newContext(Action<T> action) Creates an action context to define how the action will be scheduled for execution.
void	pause() Pauses action processing.
default <T> T	putInBindings(java.lang.String key, T value) Puts a key-value pair in the engine bindings.
default <T> T	removeFromBindings(java.lang.String key) Removes a key-value pair from the engine bindings.
void	resume() Resumes performing actions.
default ActionContext<?>	schedule(Action<?> action) Schedules an action for immediate execution.
default <T> ActionContext<T>	schedule(Action<T> action, T actor) Schedules an action referencing an actor for immediate execution.
void	stop() Permanently stops the engine.

Method Detail

getBindings

ActionBindings getBindings()

Bindings for this engine.

Returns:

Engine bindings.

isPaused

boolean isPaused()

Whether the engine is paused.

Returns:

Paused state.

isStopped

boolean isStopped()

Whether the engine is stopped.

Returns:

Stopped state.

newContext

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

Creates an action context to define how the action will be scheduled for execution.

Parameters:

action - Action to create context for.

Returns:

Context associated to the action.

pause

void pause()

Pauses action processing.

putInBindings

default <T> T putInBindings(java.lang.String key,
                            T value)

Puts a key-value pair in the engine bindings.

Parameters:

key - Key.

value - Value.

Returns:

Previously assigned value for the key.

See Also:

ActionBindings.put(String, Object)

removeFromBindings

default <T> T removeFromBindings(java.lang.String key)

Removes a key-value pair from the engine bindings.

Parameters:

key - Key.

Returns:

The previously assigned value for this key.

See Also:

ActionBindings.remove(String)

resume

void resume()

Resumes performing actions.

schedule

default ActionContext<?> schedule(Action<?> action)

Schedules an action for immediate execution.

Parameters:

action - Action to schedule.

Returns:

Context associated to action (immutable).

schedule

default <T> ActionContext<T> schedule(Action<T> action,
                                      T actor)

Schedules an action referencing an actor for immediate execution.

Parameters:

action - Action to schedule.

actor - Actor to reference.

Returns:

Context associated to action (immutable).

stop

void stop()

Permanently stops the engine. All work that has not yet been executed will be cancelled and all work currently executing will may be interrupted.