com.simsilica.es.server

Class EntityDataWrapper

java.lang.Object

com.simsilica.es.server.EntityDataWrapper

All Implemented Interfaces:

com.simsilica.es.EntityData, com.simsilica.es.ObservableEntityData

public class EntityDataWrapper
extends java.lang.Object
implements com.simsilica.es.ObservableEntityData

A client-specific view of the EntityData that wraps a delegate EntityData and passes most calls directly through but accumulates EventChanges in its own queue to be applied at a later time. EntitySets and WatchedEntities are created locally to this this EntityDataWrapper so that they don't get entity change notifications until later snapshot processing.

The main purpose of this wrapper is to have a consistent view between the EntityChanges applied and what the EntitySets have queued. This facilitates sending appropriate changes to the client 'mirror' of this data.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	EntityDataWrapper.LocalEntitySet A local DefaultEntitySet subclass only so that we can have access to some protected methods and potentially hook into some other stuff.

Constructor Summary

Constructors

Constructor and Description
EntityDataWrapper(com.simsilica.es.ObservableEntityData delegate)

Method Summary

Modifier and Type	Method and Description
void	addEntityComponentListener(com.simsilica.es.EntityComponentListener l)
boolean	applyChanges(java.util.List<com.simsilica.es.EntityChange> updates) Applies the queued changes to this
void	close()
com.simsilica.es.EntityId	createEntity()
protected void	entityChange(com.simsilica.es.EntityChange change)
java.util.Set<com.simsilica.es.EntityId>	findEntities(com.simsilica.es.ComponentFilter filter, java.lang.Class... types)
com.simsilica.es.EntityId	findEntity(com.simsilica.es.ComponentFilter filter, java.lang.Class... types)
protected com.simsilica.es.ComponentFilter	forType(com.simsilica.es.ComponentFilter filter, java.lang.Class type)
<T extends com.simsilica.es.EntityComponent> T	getComponent(com.simsilica.es.EntityId entityId, java.lang.Class<T> type)
com.simsilica.es.EntitySet	getEntities(java.lang.Class... types)
com.simsilica.es.EntitySet	getEntities(com.simsilica.es.ComponentFilter filter, java.lang.Class... types)
com.simsilica.es.Entity	getEntity(com.simsilica.es.EntityId entityId, java.lang.Class... types)
com.simsilica.es.StringIndex	getStrings()
java.lang.Class<com.simsilica.es.EntityComponent>[]	getTypes(com.simsilica.es.EntitySet set) Provides direct access to a set's type list to allow efficient mark/sweep iteration.
void	registerComponentVisibility(ComponentVisibility visibility) Registers a ComponentVisibility strategy object that will limit this client's view of the specific handled component values.
<T extends com.simsilica.es.EntityComponent> boolean	removeComponent(com.simsilica.es.EntityId entityId, java.lang.Class<T> type)
void	removeEntity(com.simsilica.es.EntityId entityId)
void	removeEntityComponentListener(com.simsilica.es.EntityComponentListener l)
void	setComponent(com.simsilica.es.EntityId entityId, com.simsilica.es.EntityComponent component)
void	setComponents(com.simsilica.es.EntityId entityId, com.simsilica.es.EntityComponent... components)
com.simsilica.es.WatchedEntity	watchEntity(com.simsilica.es.EntityId entityId, java.lang.Class... types)

Methods inherited from class java.lang.Object

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

Constructor Detail

EntityDataWrapper

public EntityDataWrapper(com.simsilica.es.ObservableEntityData delegate)

Method Detail

registerComponentVisibility

public void registerComponentVisibility(ComponentVisibility visibility)

Registers a ComponentVisibility strategy object that will limit this client's view of the specific handled component values. To the client seeing this EntityDataWrapper, invisible component values appear not to exist.

getTypes

public java.lang.Class<com.simsilica.es.EntityComponent>[] getTypes(com.simsilica.es.EntitySet set)

Provides direct access to a set's type list to allow efficient mark/sweep iteration.

createEntity

public com.simsilica.es.EntityId createEntity()

Specified by:

createEntity in interface com.simsilica.es.EntityData

removeEntity

public void removeEntity(com.simsilica.es.EntityId entityId)

Specified by:

removeEntity in interface com.simsilica.es.EntityData

setComponent

public void setComponent(com.simsilica.es.EntityId entityId,
                         com.simsilica.es.EntityComponent component)

Specified by:

setComponent in interface com.simsilica.es.EntityData

setComponents

public void setComponents(com.simsilica.es.EntityId entityId,
                          com.simsilica.es.EntityComponent... components)

Specified by:

setComponents in interface com.simsilica.es.EntityData

removeComponent

public <T extends com.simsilica.es.EntityComponent> boolean removeComponent(com.simsilica.es.EntityId entityId,
                                                                            java.lang.Class<T> type)

Specified by:

removeComponent in interface com.simsilica.es.EntityData

getComponent

public <T extends com.simsilica.es.EntityComponent> T getComponent(com.simsilica.es.EntityId entityId,
                                                                   java.lang.Class<T> type)

Specified by:

getComponent in interface com.simsilica.es.EntityData

getEntity

public com.simsilica.es.Entity getEntity(com.simsilica.es.EntityId entityId,
                                         java.lang.Class... types)

Specified by:

getEntity in interface com.simsilica.es.EntityData

findEntity

public com.simsilica.es.EntityId findEntity(com.simsilica.es.ComponentFilter filter,
                                            java.lang.Class... types)

Specified by:

findEntity in interface com.simsilica.es.EntityData

forType

protected com.simsilica.es.ComponentFilter forType(com.simsilica.es.ComponentFilter filter,
                                                   java.lang.Class type)

findEntities

public java.util.Set<com.simsilica.es.EntityId> findEntities(com.simsilica.es.ComponentFilter filter,
                                                             java.lang.Class... types)

Specified by:

findEntities in interface com.simsilica.es.EntityData

getEntities

public com.simsilica.es.EntitySet getEntities(java.lang.Class... types)

Specified by:

getEntities in interface com.simsilica.es.EntityData

getEntities

public com.simsilica.es.EntitySet getEntities(com.simsilica.es.ComponentFilter filter,
                                              java.lang.Class... types)

Specified by:

getEntities in interface com.simsilica.es.EntityData

watchEntity

public com.simsilica.es.WatchedEntity watchEntity(com.simsilica.es.EntityId entityId,
                                                  java.lang.Class... types)

Specified by:

watchEntity in interface com.simsilica.es.EntityData

getStrings

public com.simsilica.es.StringIndex getStrings()

Specified by:

getStrings in interface com.simsilica.es.EntityData

addEntityComponentListener

public void addEntityComponentListener(com.simsilica.es.EntityComponentListener l)

Specified by:

addEntityComponentListener in interface com.simsilica.es.ObservableEntityData

removeEntityComponentListener

public void removeEntityComponentListener(com.simsilica.es.EntityComponentListener l)

Specified by:

removeEntityComponentListener in interface com.simsilica.es.ObservableEntityData

close

public void close()

Specified by:

close in interface com.simsilica.es.EntityData

applyChanges

public boolean applyChanges(java.util.List<com.simsilica.es.EntityChange> updates)

Applies the queued changes to this

entityChange

protected void entityChange(com.simsilica.es.EntityChange change)