jalse.entities

Class DefaultEntityProxyFactory

java.lang.Object

jalse.entities.DefaultEntityProxyFactory

All Implemented Interfaces:

EntityProxyFactory

public class DefaultEntityProxyFactory
extends java.lang.Object
implements EntityProxyFactory

This is the default EntityProxyFactory implementation for JALSE. This proxy factory will use EntityFunctionResolver to resolve an EntityFunction to translate the proxy Method calls to EntityMethods. Override addResolverFunctions() to change what EntityMethodFunctions are added to the resolver.

NOTE: Proxies are cached per Entity using DefaultEntityProxyFactory.EntityProxyCache.

See Also:

uncacheProxyOfEntity(Entity, Class), uncacheProxiesOfEntity(Entity), uncacheAllProxies()

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	DefaultEntityProxyFactory.EntityProxyCache A WeakHashMap cache for Entity proxies.
protected class	DefaultEntityProxyFactory.EntityProxyHandler The InvocationHandler for the entity proxies.

Field Summary

Fields

Modifier and Type	Field and Description
protected DefaultEntityProxyFactory.EntityProxyCache	cache Proxy cache for entities.
protected EntityFunctionResolver	resolver Resolver for entity types.

Constructor Summary

Constructors

Constructor and Description
DefaultEntityProxyFactory() Creates a new DefaultEntityProxyFactory.

Method Summary

Modifier and Type	Method and Description
protected void	addResolverFunctions() Adds the EntityMethodFunctions to the resolver.
boolean	isProxyEntity(Entity e) Checks whether the supplied entity is a proxy.
<T extends Entity> T	proxyOfEntity(Entity e, java.lang.Class<T> type) Creates a proxy of the entity subclass.
void	uncacheAllProxies() Uncaches all proxies.
void	uncacheProxiesOfEntity(Entity e) Uncaches all proxies for an entity.
void	uncacheProxyOfEntity(Entity e, java.lang.Class<? extends Entity> type) Uncaches the specific type proxy for an entity.
void	validateType(java.lang.Class<? extends Entity> type) Validates the type can be proxied.

Methods inherited from class java.lang.Object

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

Field Detail

resolver

protected final EntityFunctionResolver resolver

Resolver for entity types.

cache

protected final DefaultEntityProxyFactory.EntityProxyCache cache

Proxy cache for entities.

Constructor Detail

DefaultEntityProxyFactory

public DefaultEntityProxyFactory()

Creates a new DefaultEntityProxyFactory.

See Also:

addResolverFunctions()

Method Detail

addResolverFunctions

protected void addResolverFunctions()

Adds the EntityMethodFunctions to the resolver.

See Also:

DefaultFunction, GetAttributeFunction, SetAttributeFunction, NewEntityFunction, GetEntityFunction, StreamEntitiesFunction, GetEntitiesFunction, KillEntityFunction, KillEntitiesFunction, MarkAsTypeFunction, UnmarkAsTypeFunction, ScheduleForActorFunction

isProxyEntity

public boolean isProxyEntity(Entity e)

Description copied from interface: EntityProxyFactory

Checks whether the supplied entity is a proxy.

Specified by:

isProxyEntity in interface EntityProxyFactory

Parameters:

e - Entity to check.

Returns:

Whether the entity was a proxy.

proxyOfEntity

public <T extends Entity> T proxyOfEntity(Entity e,
                                          java.lang.Class<T> type)

Description copied from interface: EntityProxyFactory

Creates a proxy of the entity subclass.

Specified by:

proxyOfEntity in interface EntityProxyFactory

Parameters:

e - Entity to proxy for.

type - Type to proxy as.

Returns:

The proxy.

uncacheAllProxies

public void uncacheAllProxies()

Uncaches all proxies.

uncacheProxiesOfEntity

public void uncacheProxiesOfEntity(Entity e)

Uncaches all proxies for an entity.

Parameters:

e - Entity to uncache for.

uncacheProxyOfEntity

public void uncacheProxyOfEntity(Entity e,
                                 java.lang.Class<? extends Entity> type)

Uncaches the specific type proxy for an entity.

Parameters:

e - Entity to uncache for.

type - Proxy type.

validateType

public void validateType(java.lang.Class<? extends Entity> type)

Description copied from interface: EntityProxyFactory

Validates the type can be proxied.

Specified by:

validateType in interface EntityProxyFactory

Parameters:

type - Type to validate.