com.simsilica.es.base

Class DefaultEntitySet

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<Entity>

com.simsilica.es.base.DefaultEntitySet

All Implemented Interfaces:

EntitySet, java.lang.Iterable<Entity>, java.util.Collection<Entity>, java.util.Set<Entity>

public class DefaultEntitySet
extends java.util.AbstractSet<Entity>
implements EntitySet

A set of entities that possess certain components with automatic updates as the entity components change.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DefaultEntitySet.RemovedComponent A special entity component that is used during transaction processing to temporarily mark a component as "removed".
protected class	DefaultEntitySet.Transaction Keeps accumulated data about a set of changes.

Field Summary

Fields

Modifier and Type	Field and Description
protected static DefaultEntitySet.RemovedComponent	REMOVED_COMPONENT Constant used during transaction processing to mark removed components in already loaded entities.
protected DefaultEntitySet.Transaction	transaction

Constructor Summary

Constructors

Constructor and Description
DefaultEntitySet(EntityData ed, ComponentFilter filter, java.lang.Class<EntityComponent>[] types)

Method Summary

Modifier and Type	Method and Description
boolean	add(Entity e)
boolean	applyChanges() Applies any accumulated changes to this list's entities since the last time it was called and returns true if there were changes.
boolean	applyChanges(java.util.Set<EntityChange> updates) Deprecated.
protected boolean	applyChanges(java.util.Set<EntityChange> updates, boolean clearChangeSets)
protected boolean	buildTransactionChanges(java.util.Set<EntityChange> updates)
void	clear()
void	clearChangeSets() Clears all pending change sets accumulated during the last applyChanges().
protected boolean	completeEntity(DefaultEntity e) Called by the Transaction object to fill in the missing components for an entity if this is the first time it's been seen by the set and may not have all of its components yet.
boolean	contains(java.lang.Object e)
boolean	containsId(EntityId id) Returns true if this set contains the entity with the specified ID.
java.lang.String	debugId()
protected void	entityChange(EntityChange change)
protected boolean	entityMatches(Entity e)
boolean	equals(java.lang.Object o)
java.util.Set<Entity>	getAddedEntities() Returns the entities that were added during applyChanges.
java.util.Set<Entity>	getChangedEntities() Returns the entities that were changed during applyChanges.
protected java.util.concurrent.ConcurrentLinkedQueue<EntityChange>	getChangeQueue()
Entity	getEntity(EntityId id) Returns this set's version of the Entity for the specified ID or null if this set does not contain the specified entity.
java.util.Set<EntityId>	getEntityIds() Returns all of the EntityIds currently in this set.
protected ComponentFilter	getMainFilter()
java.util.Set<Entity>	getRemovedEntities() Returns the entities that were removed during applyChanges.
protected java.lang.Class<EntityComponent>[]	getTypes()
boolean	hasChanges() Returns true if there were entity changes during the last applyChanges().
boolean	hasFilterChanged()
boolean	hasType(java.lang.Class type) Returns true if this EntitySet is made of entities that have the specified type of component.
protected boolean	isMatchingComponent(EntityComponent c) Returns true if the specific component matches the criteria for this entity set.
protected boolean	isReleased()
protected boolean	isRelevantChange(EntityChange change)
java.util.Iterator<Entity>	iterator()
protected void	loadEntities(boolean reload) Called to have the entity set load its initial set of data.
protected void	purgeEntities() Removes entities from the set that no longer match the set's criteria.
void	release() Releases this entity set from processing further entity updates and destroys any internal data structures.
protected Entity	remove(EntityId id)
boolean	remove(java.lang.Object e)
void	resetFilter(ComponentFilter filter) Swaps out the current main filter for a new one.
protected void	setMainFilter(ComponentFilter filter)
int	size()

Methods inherited from class java.util.AbstractSet

hashCode, removeAll

Methods inherited from class java.util.AbstractCollection

addAll, containsAll, isEmpty, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Set

addAll, containsAll, hashCode, isEmpty, removeAll, retainAll, spliterator, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Field Detail

REMOVED_COMPONENT

protected static final DefaultEntitySet.RemovedComponent REMOVED_COMPONENT

Constant used during transaction processing to mark removed components in already loaded entities. This distinguishes them from components that have yet to be filled in and prevents the values from being re-retrieved during transaction finalization.

transaction

protected DefaultEntitySet.Transaction transaction

Constructor Detail

DefaultEntitySet

public DefaultEntitySet(EntityData ed,
                        ComponentFilter filter,
                        java.lang.Class<EntityComponent>[] types)

Method Detail

getTypes

protected java.lang.Class<EntityComponent>[] getTypes()

debugId

public java.lang.String debugId()

setMainFilter

protected void setMainFilter(ComponentFilter filter)

getMainFilter

protected ComponentFilter getMainFilter()

loadEntities

protected void loadEntities(boolean reload)

Called to have the entity set load its initial set of data. This is called during creation (but not construction) and when the filter is reset.

purgeEntities

protected void purgeEntities()

Removes entities from the set that no longer match the set's criteria. This will update the removedEntities tracking.

resetFilter

public void resetFilter(ComponentFilter filter)

Swaps out the current main filter for a new one. Returns true if the entity set was changed during this process. This is similar to applyChanges() and any current pending changes will be applied during the filter transition.

Specified by:

resetFilter in interface EntitySet

containsId

public boolean containsId(EntityId id)

Description copied from interface: EntitySet

Returns true if this set contains the entity with the specified ID.

Specified by:

containsId in interface EntitySet

getEntityIds

public java.util.Set<EntityId> getEntityIds()

Description copied from interface: EntitySet

Returns all of the EntityIds currently in this set.

Specified by:

getEntityIds in interface EntitySet

getEntity

public Entity getEntity(EntityId id)

Description copied from interface: EntitySet

Returns this set's version of the Entity for the specified ID or null if this set does not contain the specified entity.

Specified by:

getEntity in interface EntitySet

equals

public boolean equals(java.lang.Object o)

Specified by:

equals in interface java.util.Collection<Entity>

Specified by:

equals in interface java.util.Set<Entity>

Overrides:

equals in class java.util.AbstractSet<Entity>

size

public int size()

Specified by:

size in interface java.util.Collection<Entity>

Specified by:

size in interface java.util.Set<Entity>

Specified by:

size in class java.util.AbstractCollection<Entity>

iterator

public java.util.Iterator<Entity> iterator()

Specified by:

iterator in interface java.lang.Iterable<Entity>

Specified by:

iterator in interface java.util.Collection<Entity>

Specified by:

iterator in interface java.util.Set<Entity>

Specified by:

iterator in class java.util.AbstractCollection<Entity>

clear

public void clear()

Specified by:

clear in interface java.util.Collection<Entity>

Specified by:

clear in interface java.util.Set<Entity>

Overrides:

clear in class java.util.AbstractCollection<Entity>

add

public boolean add(Entity e)

Specified by:

add in interface java.util.Collection<Entity>

Specified by:

add in interface java.util.Set<Entity>

Overrides:

add in class java.util.AbstractCollection<Entity>

remove

protected Entity remove(EntityId id)

remove

public boolean remove(java.lang.Object e)

Specified by:

remove in interface java.util.Collection<Entity>

Specified by:

remove in interface java.util.Set<Entity>

Overrides:

remove in class java.util.AbstractCollection<Entity>

contains

public boolean contains(java.lang.Object e)

Specified by:

contains in interface java.util.Collection<Entity>

Specified by:

contains in interface java.util.Set<Entity>

Overrides:

contains in class java.util.AbstractCollection<Entity>

getAddedEntities

public java.util.Set<Entity> getAddedEntities()

Returns the entities that were added during applyChanges.

Specified by:

getAddedEntities in interface EntitySet

getChangedEntities

public java.util.Set<Entity> getChangedEntities()

Returns the entities that were changed during applyChanges.

Specified by:

getChangedEntities in interface EntitySet

getRemovedEntities

public java.util.Set<Entity> getRemovedEntities()

Returns the entities that were removed during applyChanges.

Specified by:

getRemovedEntities in interface EntitySet

clearChangeSets

public void clearChangeSets()

Description copied from interface: EntitySet

Clears all pending change sets accumulated during the last applyChanges(). The change sets are automatically cleared at the beginning of the next applyChanges() but sometimes it can be useful to free them early (if the change set is large, etc.).

Specified by:

clearChangeSets in interface EntitySet

hasChanges

public boolean hasChanges()

Description copied from interface: EntitySet

Returns true if there were entity changes during the last applyChanges().

Specified by:

hasChanges in interface EntitySet

applyChanges

public boolean applyChanges()

Applies any accumulated changes to this list's entities since the last time it was called and returns true if there were changes.

Specified by:

applyChanges in interface EntitySet

applyChanges

@Deprecated
public boolean applyChanges(java.util.Set<EntityChange> updates)

Deprecated.

Applies any accumulated changes to this list's entities since the last time it was called and returns true if there were changes. Changes that caused an update (not an add or a remove) will be added to the supplied updates set.

Specified by:

applyChanges in interface EntitySet

buildTransactionChanges

protected boolean buildTransactionChanges(java.util.Set<EntityChange> updates)

hasFilterChanged

public boolean hasFilterChanged()

applyChanges

protected boolean applyChanges(java.util.Set<EntityChange> updates,
                               boolean clearChangeSets)

release

public void release()

Releases this entity set from processing further entity updates and destroys any internal data structures.

Specified by:

release in interface EntitySet

isReleased

protected boolean isReleased()

entityMatches

protected boolean entityMatches(Entity e)

isMatchingComponent

protected boolean isMatchingComponent(EntityComponent c)

Returns true if the specific component matches the criteria for this entity set.

hasType

public final boolean hasType(java.lang.Class type)

Description copied from interface: EntitySet

Returns true if this EntitySet is made of entities that have the specified type of component.

Specified by:

hasType in interface EntitySet

isRelevantChange

protected boolean isRelevantChange(EntityChange change)

entityChange

protected void entityChange(EntityChange change)

completeEntity

protected boolean completeEntity(DefaultEntity e)

Called by the Transaction object to fill in the missing components for an entity if this is the first time it's been seen by the set and may not have all of its components yet.

getChangeQueue

protected java.util.concurrent.ConcurrentLinkedQueue<EntityChange> getChangeQueue()