jalse.actions

Class AbstractActionEngine

java.lang.Object

jalse.actions.AbstractActionEngine

All Implemented Interfaces:

ActionEngine

Direct Known Subclasses:

ForkJoinActionEngine, ThreadPoolActionEngine

public abstract class AbstractActionEngine
extends java.lang.Object
implements ActionEngine

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

If the engine is paused the incoming resumed state change can be awaited ( awaitResumed()).

See Also:

TERMINATION_TIMEOUT, DefaultActionBindings

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.concurrent.ExecutorService	executorService Executor service to be used for action scheduling.
static long	TERMINATION_TIMEOUT How long the engine will wait until it times out and interrupts running threads on shutdown (configured via jalse.actions.termination_timeout system property).

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractActionEngine(java.util.concurrent.ExecutorService executorService) Creates a new instance of AbstractActionEngine with the supplied executor service.

Method Summary

Modifier and Type	Method and Description
protected void	awaitResumed() Will wait until the engine has resumed (or stopped).
ActionBindings	getBindings() Bindings for this engine.
boolean	isPaused() Whether the engine is paused.
boolean	isStopped() Whether the engine is stopped.
void	pause() Pauses action processing.
void	resume() Resumes performing actions.
void	stop() Permanently stops the engine.

Methods inherited from class java.lang.Object

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

Methods inherited from interface jalse.actions.ActionEngine

newContext, putInBindings, removeFromBindings, schedule, schedule

Field Detail

TERMINATION_TIMEOUT

public static long TERMINATION_TIMEOUT

How long the engine will wait until it times out and interrupts running threads on shutdown (configured via jalse.actions.termination_timeout system property).

executorService

protected final java.util.concurrent.ExecutorService executorService

Executor service to be used for action scheduling.

Constructor Detail

AbstractActionEngine

protected AbstractActionEngine(java.util.concurrent.ExecutorService executorService)

Creates a new instance of AbstractActionEngine with the supplied executor service.

Parameters:

executorService - Service to use.

See Also:

Actions.requireNotShutdown(ExecutorService)

Method Detail

awaitResumed

protected void awaitResumed()
                     throws java.lang.InterruptedException

Will wait until the engine has resumed (or stopped).

Throws:

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

getBindings

public ActionBindings getBindings()

Description copied from interface: ActionEngine

Bindings for this engine.

Specified by:

getBindings in interface ActionEngine

Returns:

Engine bindings.

isPaused

public boolean isPaused()

Description copied from interface: ActionEngine

Whether the engine is paused.

Specified by:

isPaused in interface ActionEngine

Returns:

Paused state.

isStopped

public boolean isStopped()

Description copied from interface: ActionEngine

Whether the engine is stopped.

Specified by:

isStopped in interface ActionEngine

Returns:

Stopped state.

pause

public void pause()

Description copied from interface: ActionEngine

Pauses action processing.

Specified by:

pause in interface ActionEngine

resume

public void resume()

Description copied from interface: ActionEngine

Resumes performing actions.

Specified by:

resume in interface ActionEngine

stop

public void stop()

Description copied from interface: ActionEngine

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

Specified by:

stop in interface ActionEngine