jalse.actions

Class ManualActionEngine

java.lang.Object

jalse.actions.ManualActionEngine

All Implemented Interfaces:

ActionEngine

public class ManualActionEngine
extends java.lang.Object
implements ActionEngine

A manual-tick implementation of ActionEngine. ManualActionEngine uses no additional threads and will not run any actions until resume() is called. When the engine is ticking all jobs that should be executed will be (even if past their estimated schedule time).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ManualActionEngine.ManualContext<T> Manual action context.

Constructor Summary

Constructors

Constructor and Description
ManualActionEngine() Creates a new instance of ManualActionEngine.

Method Summary

Modifier and Type	Method and Description
protected boolean	addWork(ManualActionEngine.ManualContext<?> context) Adds work to the engine.
ActionBindings	getBindings() Bindings for this engine.
protected ManualWorkQueue<ManualActionEngine.ManualContext<?>>	getWorkQueue() Gets the engine's work queue.
boolean	isPaused() Whether the engine is paused.
boolean	isStopped() Whether the engine is stopped.
<T> ManualActionEngine.ManualContext<T>	newContext(Action<T> action) Creates an action context to define how the action will be scheduled for execution.
void	pause() Pauses action processing.
protected boolean	removeWork(ManualActionEngine.ManualContext<?> context) Removes work from the engine.
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

putInBindings, removeFromBindings, schedule, schedule

Constructor Detail

ManualActionEngine

public ManualActionEngine()

Creates a new instance of ManualActionEngine.

Method Detail

addWork

protected boolean addWork(ManualActionEngine.ManualContext<?> context)

Adds work to the engine.

Parameters:

context - Work to add.

Returns:

Whether the work was not already in the queue.

See Also:

Actions.requireNotStopped(ActionEngine)

getBindings

public ActionBindings getBindings()

Description copied from interface: ActionEngine

Bindings for this engine.

Specified by:

getBindings in interface ActionEngine

Returns:

Engine bindings.

getWorkQueue

protected ManualWorkQueue<ManualActionEngine.ManualContext<?>> getWorkQueue()

Gets the engine's work queue.

Returns:

Manual work queue.

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.

newContext

public <T> ManualActionEngine.ManualContext<T> newContext(Action<T> action)

Description copied from interface: ActionEngine

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

Specified by:

newContext in interface ActionEngine

Parameters:

action - Action to create context for.

Returns:

Context associated to the action.

pause

public void pause()

Description copied from interface: ActionEngine

Pauses action processing.

Specified by:

pause in interface ActionEngine

removeWork

protected boolean removeWork(ManualActionEngine.ManualContext<?> context)

Removes work from the engine.

Parameters:

context - Work to remove.

Returns:

Whether the work was added before.

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