jalse

Class DefaultJALSE

java.lang.Object

jalse.misc.AbstractIdentifiable

jalse.DefaultJALSE

All Implemented Interfaces:

ActionEngine, ActionScheduler<JALSE>, EntityContainer, JALSE, Identifiable, Taggable

public class DefaultJALSE
extends AbstractIdentifiable
implements JALSE

A JALSE implementation that using default implementations.

DefaultJALSE uses DefaultEntityFactory (with no Entity limit) and ForkJoinActionEngine.commonPoolEngine() by default if no EntityFactory or ActionEngine are provided.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultJALSE.Builder A DefaultJALSE instance builder that uses the defined ActionEngine implementation with DefaultEntityFactory. By default this builder uses the common pool (ForkJoinActionEngine.commonPoolEngine() ), has a random ID and has no entity limit.

Field Summary

Fields

Modifier and Type	Field and Description
protected ActionEngine	engine Action engine to be supplied to entities.
protected DefaultEntityContainer	entities Backing entity container for top level entities.
protected EntityFactory	factory Entity factory for creating/killing entities.
protected DefaultActionScheduler<JALSE>	scheduler Self action scheduler.
protected TagTypeSet	tags Current state information.

Fields inherited from class jalse.misc.AbstractIdentifiable

id

Constructor Summary

Constructors

Constructor and Description
DefaultJALSE(java.util.UUID id, ActionEngine engine, EntityFactory factory) Creates a new instance of DefaultJALSE with the supplied engine and factory.

Method Summary

Modifier and Type	Method and Description
boolean	addEntityListener(EntityListener listener) Adds a listener for entities.
void	cancelAllScheduledForActor() Cancels all tasks currently running/scheduled (scheduled by this).
ActionBindings	getBindings() Bindings for this engine.
Entity	getEntity(java.util.UUID id) Gets the entity with the specified ID.
int	getEntityCount() Gets the direct entity count.
java.util.Set<java.util.UUID>	getEntityIDs() Gets the IDs of all the entities within the container.
java.util.Set<? extends EntityListener>	getEntityListeners() Gets all the entity listeners.
java.util.Set<java.util.UUID>	getIDsInTree() Gets the current set of IDs for the entire tree.
int	getTreeCount() Gets the current total number of entities.
boolean	isPaused() Whether the engine is paused.
boolean	isStopped() Whether the engine is stopped.
void	killEntities() Kills all entities.
boolean	killEntity(java.util.UUID id) Kills the specified entity.
<T> SchedulableActionContext<T>	newContext(Action<T> action) Creates an action context to define how the action will be scheduled for execution.
SchedulableActionContext<JALSE>	newContextForActor(Action<JALSE> action) Creates a new mutable context for the supplied action and this actor.
Entity	newEntity(java.util.UUID id, AttributeContainer sourceContainer) Creates new entity with the specified ID.
<T extends Entity> T	newEntity(java.util.UUID id, java.lang.Class<T> type, AttributeContainer sourceContainer) Creates new entity with the specified ID.
void	pause() Pauses action processing.
boolean	receiveEntity(Entity e) Receives an entity (from a transfer).
boolean	removeEntityListener(EntityListener listener) Removes a entity listener.
void	removeEntityListeners() Removes all listeners for entities.
void	resume() Resumes performing actions.
ActionContext<JALSE>	scheduleForActor(Action<JALSE> action, long initialDelay, long period, java.util.concurrent.TimeUnit unit) Schedules an action for execution with a supplied initial delay and repeat period.
void	stop() Permanently stops the engine.
java.util.stream.Stream<Entity>	streamEntities() Provides a stream of entities from the container.
java.util.stream.Stream<Entity>	streamEntityTree() Streams the entire entity tree.
java.util.stream.Stream<Tag>	streamTags() Streams all tag state information.
boolean	transferEntity(java.util.UUID id, EntityContainer destination) Transfers the entity to the supplied destination container.

Methods inherited from class jalse.misc.AbstractIdentifiable

equals, getID, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface jalse.JALSE

getEntityTree

Methods inherited from interface jalse.misc.Identifiable

equals, getID, getID, hashCode, is, not, toString

Methods inherited from interface jalse.actions.ActionEngine

putInBindings, removeFromBindings, schedule, schedule

Methods inherited from interface jalse.actions.ActionScheduler

scheduleForActor, scheduleForActor

Methods inherited from interface jalse.entities.EntityContainer

getEntities, getEntitiesAsType, getEntitiesOfType, getEntityAsType, getOptEntity, getOptEntityAsType, hasEntities, hasEntity, hasEntityListener, newEntity, newEntity, newEntity, newEntity, newEntity, newEntity, streamEntitiesAsType, streamEntitiesOfType, streamEntityIDs, transferAllEntities, transferEntities, transferEntities

Methods inherited from interface jalse.tags.Taggable

getTags

Field Detail

engine

protected final ActionEngine engine

Action engine to be supplied to entities.

entities

protected final DefaultEntityContainer entities

Backing entity container for top level entities.

factory

protected final EntityFactory factory

Entity factory for creating/killing entities.

scheduler

protected final DefaultActionScheduler<JALSE> scheduler

Self action scheduler.

tags

protected final TagTypeSet tags

Current state information.

Constructor Detail

DefaultJALSE

public DefaultJALSE(java.util.UUID id,
                    ActionEngine engine,
                    EntityFactory factory)

Creates a new instance of DefaultJALSE with the supplied engine and factory.

Parameters:

id - The ID used to identify between JALSE instances.

engine - Action engine to associate to factory and schedule actions.

factory - Entity factory to create/kill child entities.

Method Detail

addEntityListener

public boolean addEntityListener(EntityListener listener)

Description copied from interface: EntityContainer

Adds a listener for entities.

Specified by:

addEntityListener in interface EntityContainer

Parameters:

listener - Listener to add.

Returns:

true if container did not already contain this listener.

See Also:

ListenerSet.add(Object)

cancelAllScheduledForActor

public void cancelAllScheduledForActor()

Description copied from interface: ActionScheduler

Cancels all tasks currently running/scheduled (scheduled by this).

Specified by:

cancelAllScheduledForActor in interface ActionScheduler<JALSE>

getBindings

public ActionBindings getBindings()

Description copied from interface: ActionEngine

Bindings for this engine.

Specified by:

getBindings in interface ActionEngine

Returns:

Engine bindings.

getEntity

public Entity getEntity(java.util.UUID id)

Description copied from interface: EntityContainer

Gets the entity with the specified ID.

Specified by:

getEntity in interface EntityContainer

Parameters:

id - Unique ID of the entity.

Returns:

The entity matching the supplied id or null if none found.

getEntityCount

public int getEntityCount()

Description copied from interface: EntityContainer

Gets the direct entity count.

Specified by:

getEntityCount in interface EntityContainer

Returns:

Direct child entity count.

getEntityIDs

public java.util.Set<java.util.UUID> getEntityIDs()

Description copied from interface: EntityContainer

Gets the IDs of all the entities within the container.

Specified by:

getEntityIDs in interface EntityContainer

Returns:

Set of all entity identifiers.

getEntityListeners

public java.util.Set<? extends EntityListener> getEntityListeners()

Description copied from interface: EntityContainer

Gets all the entity listeners.

Specified by:

getEntityListeners in interface EntityContainer

Returns:

All the entity listeners.

getIDsInTree

public java.util.Set<java.util.UUID> getIDsInTree()

Description copied from interface: JALSE

Gets the current set of IDs for the entire tree.

Specified by:

getIDsInTree in interface JALSE

Returns:

All entity IDs.

See Also:

Entities.getEntityIDsRecursively(EntityContainer)

getTreeCount

public int getTreeCount()

Description copied from interface: JALSE

Gets the current total number of entities.

Specified by:

getTreeCount in interface JALSE

Returns:

Total number of entities within the simulation.

See Also:

Entities.getEntityCountRecursively(EntityContainer)

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.

killEntities

public void killEntities()

Description copied from interface: EntityContainer

Kills all entities.

Specified by:

killEntities in interface EntityContainer

killEntity

public boolean killEntity(java.util.UUID id)

Description copied from interface: EntityContainer

Kills the specified entity.

Specified by:

killEntity in interface EntityContainer

Parameters:

id - Entity ID.

Returns:

Whether the entity was alive.

newContext

public <T> SchedulableActionContext<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.

newContextForActor

public SchedulableActionContext<JALSE> newContextForActor(Action<JALSE> action)

Description copied from interface: ActionScheduler

Creates a new mutable context for the supplied action and this actor.

Specified by:

newContextForActor in interface ActionScheduler<JALSE>

Parameters:

action - Action to create context for.

Returns:

Context bound to the action and actor (immutable for actor).

newEntity

public Entity newEntity(java.util.UUID id,
                        AttributeContainer sourceContainer)

Description copied from interface: EntityContainer

Creates new entity with the specified ID.

Specified by:

newEntity in interface EntityContainer

Parameters:

id - Entity ID.

sourceContainer - Source attribute container.

Returns:

The newly created entity.

newEntity

public <T extends Entity> T newEntity(java.util.UUID id,
                                      java.lang.Class<T> type,
                                      AttributeContainer sourceContainer)

Description copied from interface: EntityContainer

Creates new entity with the specified ID. This entity is marked as the specified entity type and then wrapped to it.

Specified by:

newEntity in interface EntityContainer

Parameters:

id - Entity ID.

type - Entity type.

sourceContainer - Source attribute container.

Returns:

The newly created entity.

See Also:

Entity.markAsType(Class), Entities.asType(Entity, Class)

pause

public void pause()

Description copied from interface: ActionEngine

Pauses action processing.

Specified by:

pause in interface ActionEngine

receiveEntity

public boolean receiveEntity(Entity e)

Description copied from interface: EntityContainer

Receives an entity (from a transfer). This method may receive an entity from within or outside the tree.

Specified by:

receiveEntity in interface EntityContainer

Parameters:

e - Entity to receive.

Returns:

Whether the entity was received.

See Also:

EntityContainer.transferEntity(UUID, EntityContainer)

removeEntityListener

public boolean removeEntityListener(EntityListener listener)

Description copied from interface: EntityContainer

Removes a entity listener.

Specified by:

removeEntityListener in interface EntityContainer

Parameters:

listener - Listener to remove.

Returns:

true if the listener was removed.

See Also:

ListenerSet.remove(Object)

removeEntityListeners

public void removeEntityListeners()

Description copied from interface: EntityContainer

Removes all listeners for entities.

Specified by:

removeEntityListeners in interface EntityContainer

resume

public void resume()

Description copied from interface: ActionEngine

Resumes performing actions.

Specified by:

resume in interface ActionEngine

scheduleForActor

public ActionContext<JALSE> scheduleForActor(Action<JALSE> action,
                                             long initialDelay,
                                             long period,
                                             java.util.concurrent.TimeUnit unit)

Description copied from interface: ActionScheduler

Schedules an action for execution with a supplied initial delay and repeat period.

Specified by:

scheduleForActor in interface ActionScheduler<JALSE>

Parameters:

action - Action to schedule.

initialDelay - Initial delay before schedule (can be 0).

period - Period for repeating (can be 0).

unit - Time unit of initial delay and period.

Returns:

Context associated with the action (immutable).

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

streamEntities

public java.util.stream.Stream<Entity> streamEntities()

Description copied from interface: EntityContainer

Provides a stream of entities from the container.

Specified by:

streamEntities in interface EntityContainer

Returns:

A stream of entities in the container.

streamEntityTree

public java.util.stream.Stream<Entity> streamEntityTree()

Description copied from interface: JALSE

Streams the entire entity tree.

Specified by:

streamEntityTree in interface JALSE

Returns:

Stream of the entire tree.

See Also:

Entities.walkEntities(EntityContainer)

streamTags

public java.util.stream.Stream<Tag> streamTags()

Description copied from interface: Taggable

Streams all tag state information.

Specified by:

streamTags in interface Taggable

Returns:

Stream of all tags.

transferEntity

public boolean transferEntity(java.util.UUID id,
                              EntityContainer destination)

Description copied from interface: EntityContainer

Transfers the entity to the supplied destination container.

Specified by:

transferEntity in interface EntityContainer

Parameters:

id - Entity ID.

destination - Target container.

Returns:

Whether the entity was transfered.

See Also:

EntityContainer.receiveEntity(Entity)