jalse.entities

Class DefaultEntityContainer

java.lang.Object

jalse.entities.DefaultEntityContainer

All Implemented Interfaces:

EntityContainer

public class DefaultEntityContainer
extends java.lang.Object
implements EntityContainer

An DefaultEntityContainer is a thread-safe implementation of EntityContainer.

DefaultEntityContainer can take a delegate container to supply to EntityEvent. Entity updates will trigger these events using EntityListener.

By default DefaultEntityContainer will use DefaultEntityFactory with no delegate container.

Constructor Summary

Constructors

Constructor and Description
DefaultEntityContainer() Creates an entity container with the default entity factory and no delegate container.
DefaultEntityContainer(EntityFactory factory) Creates an entity container with the supplied factory and no delegate container.
DefaultEntityContainer(EntityFactory factory, EntityContainer delegateContainer) Creates an entity container with the supplied factory and delegate container.

Method Summary

Modifier and Type	Method and Description
boolean	addEntityListener(EntityListener listener) Adds a listener for entities.
boolean	equals(java.lang.Object obj)
EntityContainer	getDelegateContainer() Gets the delegate container for events and entity creation.
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.
EntityFactory	getFactory() Gets entity factory for this set.
int	hashCode()
void	killEntities() Kills all entities.
boolean	killEntity(java.util.UUID id) Kills the specified entity.
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.
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.
java.util.stream.Stream<Entity>	streamEntities() Provides a stream of entities from the container.
java.lang.String	toString()
boolean	transferEntity(java.util.UUID id, EntityContainer destination) Transfers the entity to the supplied destination container.

Methods inherited from class java.lang.Object

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

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

Constructor Detail

DefaultEntityContainer

public DefaultEntityContainer()

Creates an entity container with the default entity factory and no delegate container.

DefaultEntityContainer

public DefaultEntityContainer(EntityFactory factory)

Creates an entity container with the supplied factory and no delegate container.

Parameters:

factory - Entity creation/death factory.

DefaultEntityContainer

public DefaultEntityContainer(EntityFactory factory,
                              EntityContainer delegateContainer)

Creates an entity container with the supplied factory and delegate container.

Parameters:

factory - Entity creation/death factory.

delegateContainer - Delegate container for events and entity creation.

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)

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getDelegateContainer

public EntityContainer getDelegateContainer()

Gets the delegate container for events and entity creation.

Returns:

Delegate container.

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.

getFactory

public EntityFactory getFactory()

Gets entity factory for this set.

Returns:

Entity creation / death factory.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

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.

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)

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

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.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

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)