jalse.actions

Interface ActionContext<T>

Type Parameters:

T - Actor type (can be ? if no actor).

All Superinterfaces:

ActionBindings

All Known Subinterfaces:

SchedulableActionContext<T>

All Known Implementing Classes:

AbstractFutureActionContext, AbstractManualActionContext, ForkJoinActionEngine.ForkJoinContext, ManualActionEngine.ManualContext, ThreadPoolActionEngine.ThreadPoolContext

public interface ActionContext<T>
extends ActionBindings

ActionContext is supplied when running every Action. This provides contextual information about the running Action and also the ability to cancel it.

Key-value pairs may be bound for this context to be used when performing the action.

Method Summary

Modifier and Type	Method and Description
void	await() Awaits the execution (or cancellation of the action).
boolean	cancel() Cancels the associated action.
T	getActor() Gets the associated actor.
ActionEngine	getEngine() Gets the associated engine.
default java.util.Optional<T>	getOptActor() This is a convenience method for getting an actor (optional).
long	getPeriod(java.util.concurrent.TimeUnit unit) Gets the actions repeat period.
default boolean	hasActor() Whether the context has an associated actor.
boolean	isCancelled() Whether the action has been cancelled.
boolean	isDone() Whether the action has been ran (or cancelled).
default boolean	isPeriodic() Checks whether the action is periodic.
boolean	isPeriodicOnException() Whether the action will continue to reschedule on exception.

Methods inherited from interface jalse.actions.ActionBindings

containsKey, get, put, putAll, remove, removeAll, toMap

Method Detail

await

void await()
    throws java.lang.InterruptedException

Awaits the execution (or cancellation of the action).

Throws:

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

cancel

boolean cancel()

Cancels the associated action.

Returns:

Whether the action was cancelled.

getActor

T getActor()

Gets the associated actor.

Returns:

The referenced actor or null if not found.

getEngine

ActionEngine getEngine()

Gets the associated engine.

Returns:

Engine action is scheduled by from.

getOptActor

default java.util.Optional<T> getOptActor()

This is a convenience method for getting an actor (optional).

Returns:

Optional containing the referenced actor or else empty optional if not found.

getPeriod

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

Gets the actions repeat period.

Parameters:

unit - TimeUnit to convert period to.

Returns:

Period in the supplied unit.

hasActor

default boolean hasActor()

Whether the context has an associated actor.

Returns:

Whether an actor was found.

isCancelled

boolean isCancelled()

Whether the action has been cancelled.

Returns:

Cancelled state.

isDone

boolean isDone()

Whether the action has been ran (or cancelled).

Returns:

Done state.

isPeriodic

default boolean isPeriodic()

Checks whether the action is periodic.

Returns:

Whether the action is repeat scheduled.

isPeriodicOnException

boolean isPeriodicOnException()

Whether the action will continue to reschedule on exception.

Returns:

Whether it continues when an exception is thrown.