jalse.entities

Class DefaultEntityFactory

java.lang.Object

jalse.entities.DefaultEntityFactory

All Implemented Interfaces:

EntityFactory

public class DefaultEntityFactory
extends java.lang.Object
implements EntityFactory

A EntityFactory implementation that creates/kills DefaultEntity. Default entity factory can have a total entity limit set. When this factory kills an entity it will kill the entity tree under it (can only kill entities his factory has created).

This factory assumes all source containers (and when importing target containers) are genuine.

If no ActionEngine is supplied ForkJoinActionEngine.commonPoolEngine() will be used.

Constructor Summary

Constructors

Constructor and Description
DefaultEntityFactory() Creates a default entity factory with no entity limit.
DefaultEntityFactory(int entityLimit) Creates a default entity factory with the supplied entity limit.

Method Summary

Modifier and Type	Method and Description
void	exportEntity(Entity e) Exports an entity (removing all references).
ActionEngine	getEngine() Gets the associated engine.
int	getEntityCount() Gets the current total entity count.
int	getEntityLimit() Gets the total entity limit.
DefaultEntity	newEntity(java.util.UUID id, EntityContainer target) Creates a new entity with the specified ID and parent container.
void	setEngine(ActionEngine engine) Sets the engine to supply to new entities.
java.lang.String	toString()
boolean	tryImportEntity(Entity e, EntityContainer target) Imports the entity into the factory.
boolean	tryKillEntity(Entity e) Kills the specified entity.
boolean	tryTakeFromTree(Entity e, EntityContainer target) Tries to take the entity from within the tree if possible.
boolean	withinSameTree(EntityContainer source, EntityContainer target) Checks if the two containers are within the same tree (for in tree transfer or export).

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultEntityFactory

public DefaultEntityFactory()

Creates a default entity factory with no entity limit.

DefaultEntityFactory

public DefaultEntityFactory(int entityLimit)

Creates a default entity factory with the supplied entity limit.

Parameters:

entityLimit - Maximum entity limit.

Method Detail

exportEntity

public void exportEntity(Entity e)

Description copied from interface: EntityFactory

Exports an entity (removing all references).

Specified by:

exportEntity in interface EntityFactory

Parameters:

e - Entity to detach.

getEngine

public ActionEngine getEngine()

Gets the associated engine.

Returns:

Action engine.

getEntityCount

public int getEntityCount()

Gets the current total entity count.

Returns:

Entity count.

getEntityLimit

public int getEntityLimit()

Gets the total entity limit.

Returns:

Entity limit.

newEntity

public DefaultEntity newEntity(java.util.UUID id,
                               EntityContainer target)

Description copied from interface: EntityFactory

Creates a new entity with the specified ID and parent container.

Specified by:

newEntity in interface EntityFactory

Parameters:

id - Entity ID.

target - Parent container.

Returns:

Newly created entity.

setEngine

public void setEngine(ActionEngine engine)

Description copied from interface: EntityFactory

Sets the engine to supply to new entities.

Specified by:

setEngine in interface EntityFactory

Parameters:

engine - Action engine.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

tryImportEntity

public boolean tryImportEntity(Entity e,
                               EntityContainer target)

Description copied from interface: EntityFactory

Imports the entity into the factory.

Specified by:

tryImportEntity in interface EntityFactory

Parameters:

e - Entity to import.

target - Target container.

Returns:

Whether the entity was imported.

tryKillEntity

public boolean tryKillEntity(Entity e)

Description copied from interface: EntityFactory

Kills the specified entity.

Specified by:

tryKillEntity in interface EntityFactory

Parameters:

e - Entity to kill.

Returns:

Whether the entity was killed.

tryTakeFromTree

public boolean tryTakeFromTree(Entity e,
                               EntityContainer target)

Description copied from interface: EntityFactory

Tries to take the entity from within the tree if possible.

Specified by:

tryTakeFromTree in interface EntityFactory

Parameters:

e - Entity to take.

target - Target container.

Returns:

Whether the entity could be taken from within the tree.

withinSameTree

public boolean withinSameTree(EntityContainer source,
                              EntityContainer target)

Description copied from interface: EntityFactory

Checks if the two containers are within the same tree (for in tree transfer or export).

Specified by:

withinSameTree in interface EntityFactory

Parameters:

source - Source container.

target - Target container.

Returns:

Whether they're within the same tree.