jalse.actions

Class Actions

java.lang.Object

jalse.actions.Actions

public final class Actions
extends java.lang.Object

A utility for Action related functionality.

Field Summary

Fields

Modifier and Type	Field and Description
static ActionBindings	EMPTY_ACTIONBINDINGS An empty ActionBindings instance.
static SchedulableActionContext	EMPTY_ACTIONCONTEXT An empty SchedulableActionContext instance.
static ActionEngine	EMPTY_ACTIONENGINE An empty ActionEngine instance.

Method Summary

Modifier and Type	Method and Description
static <T> void	copy(ActionContext<T> source, SchedulableActionContext<T> target) Copies context information to a target context (actor, bindings, initial delay and period).
static ActionBindings	emptyActionBindings() Creates an immutable empty ActionBindings.
static <T> SchedulableActionContext<T>	emptyActionContext() Creates an immutable empty SchedulableActionContext.
static ActionEngine	emptyActionEngine() Creates an immutable empty ActionEngine.
static <T extends java.util.concurrent.ExecutorService> T	requireNotShutdown(T executorService) Validates the supplied service is not shutdown.
static ActionEngine	requireNotStopped(ActionEngine engine) Validates the supplied engine is not stopped.
static ActionBindings	unmodifiableActionBindings(ActionBindings bindings) Creates an immutable ActionBindings.
static ActionEngine	unmodifiableActionEngine(ActionEngine engine) Creates an immutable ActionEngine.
static <T> SchedulableActionContext<T>	unschedulableActionContext(SchedulableActionContext<T> context) Creates an immutable SchedulableActionContext that ActionContext.cancel() and ActionContext.await() can still be called.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_ACTIONENGINE

public static final ActionEngine EMPTY_ACTIONENGINE

An empty ActionEngine instance.

EMPTY_ACTIONBINDINGS

public static final ActionBindings EMPTY_ACTIONBINDINGS

An empty ActionBindings instance.

EMPTY_ACTIONCONTEXT

public static final SchedulableActionContext EMPTY_ACTIONCONTEXT

An empty SchedulableActionContext instance.

Method Detail

copy

public static <T> void copy(ActionContext<T> source,
                            SchedulableActionContext<T> target)

Copies context information to a target context (actor, bindings, initial delay and period).

Parameters:

source - Source context.

target - Target context.

emptyActionBindings

public static ActionBindings emptyActionBindings()

Creates an immutable empty ActionBindings.

Returns:

Empty bindings.

emptyActionContext

public static <T> SchedulableActionContext<T> emptyActionContext()

Creates an immutable empty SchedulableActionContext.

Returns:

Empty context.

emptyActionEngine

public static ActionEngine emptyActionEngine()

Creates an immutable empty ActionEngine.

Returns:

Empty action engine.

requireNotShutdown

public static <T extends java.util.concurrent.ExecutorService> T requireNotShutdown(T executorService)

Validates the supplied service is not shutdown.

Parameters:

executorService - Service to check.

Returns:

The service.

requireNotStopped

public static ActionEngine requireNotStopped(ActionEngine engine)
                                      throws java.lang.IllegalStateException

Validates the supplied engine is not stopped.

Parameters:

engine - Engine to check.

Returns:

The engine.

Throws:

java.lang.IllegalStateException

unmodifiableActionBindings

public static ActionBindings unmodifiableActionBindings(ActionBindings bindings)

Creates an immutable ActionBindings.

Parameters:

bindings - Bindings to wrap.

Returns:

Immutable bindings.

unmodifiableActionEngine

public static ActionEngine unmodifiableActionEngine(ActionEngine engine)

Creates an immutable ActionEngine.

Parameters:

engine - engine to wrap.

Returns:

Immutable bindings.

unschedulableActionContext

public static <T> SchedulableActionContext<T> unschedulableActionContext(SchedulableActionContext<T> context)

Creates an immutable SchedulableActionContext that ActionContext.cancel() and ActionContext.await() can still be called.

Parameters:

context - Context to wrap.

Returns:

Immutable context.