org.trimou.engine.resolver

Class ReflectionResolver

java.lang.Object

org.trimou.engine.config.AbstractConfigurationAware

org.trimou.engine.resolver.AbstractResolver

org.trimou.engine.resolver.ReflectionResolver

All Implemented Interfaces:

com.google.common.cache.RemovalListener<org.trimou.engine.resolver.MemberKey,com.google.common.base.Optional<org.trimou.engine.resolver.MemberWrapper>>, ConfigurationAware, WithPriority, Resolver

public class ReflectionResolver
extends AbstractResolver
implements com.google.common.cache.RemovalListener<org.trimou.engine.resolver.MemberKey,com.google.common.base.Optional<org.trimou.engine.resolver.MemberWrapper>>

Reflection-based resolver attempts to find a matching member on the context object class and its superclasses. Methods have higher priority than fields.

Author:

Martin Kouba

See Also:

Reflections.findField(Class, String), Reflections.findMethod(Class, String)

Field Summary

Fields

Modifier and Type	Field and Description
static ConfigurationKey	MEMBER_CACHE_MAX_SIZE_KEY Limit the size of the cache (e.g. to avoid problems when dynamic class compilation is involved).
static int	REFLECTION_RESOLVER_PRIORITY

Fields inherited from interface org.trimou.engine.priority.WithPriority

BUILTIN_RESOLVERS_DEFAULT_PRIORITY, BUILTIN_TEMPLATE_LOCATORS_DEFAULT_PRIORITY, EXTENSION_RESOLVERS_DEFAULT_PRIORITY

Constructor Summary

Constructors

Constructor and Description
ReflectionResolver()
ReflectionResolver(int priority)

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Set<ConfigurationKey>	getConfigurationKeys()
void	init(Configuration configuration) Initialize the component.
void	invalidateMemberCache(com.google.common.base.Predicate<java.lang.Class<?>> predicate) The member cache may theoretically cause memory leaks due to using hard references to Class and Member instances.
void	onRemoval(com.google.common.cache.RemovalNotification<org.trimou.engine.resolver.MemberKey,com.google.common.base.Optional<org.trimou.engine.resolver.MemberWrapper>> notification)
java.lang.Object	resolve(java.lang.Object contextObject, java.lang.String name, ResolutionContext context) Resolve the value from specified context object and name.

Methods inherited from class org.trimou.engine.resolver.AbstractResolver

getPriority, toString

Methods inherited from class org.trimou.engine.config.AbstractConfigurationAware

checkNotInitialized

Methods inherited from class java.lang.Object

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

Field Detail

REFLECTION_RESOLVER_PRIORITY

public static final int REFLECTION_RESOLVER_PRIORITY

MEMBER_CACHE_MAX_SIZE_KEY

public static final ConfigurationKey MEMBER_CACHE_MAX_SIZE_KEY

Limit the size of the cache (e.g. to avoid problems when dynamic class compilation is involved). Use zero value to disable the cache.

See Also:

CacheBuilder.maximumSize(long)

Constructor Detail

ReflectionResolver

public ReflectionResolver()

ReflectionResolver

public ReflectionResolver(int priority)

Method Detail

resolve

public java.lang.Object resolve(java.lang.Object contextObject,
                       java.lang.String name,
                       ResolutionContext context)

Description copied from interface: Resolver

Resolve the value from specified context object and name. This method should return as fast as possible. The best practice is to verify params first and return null in case of the resolver is not capable of resolving it. ResolutionContext allows to register a callback to release all the relevant resources after the resolved value is used.

Specified by:

resolve in interface Resolver

Parameters:

contextObject - The current context object (aka base object), may be null

name - The name (the key or its part) is never null

context - The current resolution context

Returns:

the resolved object or null

init

public void init(Configuration configuration)

Description copied from interface: ConfigurationAware

Initialize the component. Keep in mind that the configuration itself might not be fully initialized yet. However it should be safe to inspect non-configurable components (e.g. properties and global data) and obtain references to other ConfigurationAware components e.g. ( LocaleSupport). This method must not be called directly by the application.

Specified by:

init in interface ConfigurationAware

Overrides:

init in class AbstractConfigurationAware

getConfigurationKeys

public java.util.Set<ConfigurationKey> getConfigurationKeys()

Specified by:

getConfigurationKeys in interface ConfigurationAware

Overrides:

getConfigurationKeys in class AbstractConfigurationAware

Returns:

the set of configuration keys to discover

onRemoval

public void onRemoval(com.google.common.cache.RemovalNotification<org.trimou.engine.resolver.MemberKey,com.google.common.base.Optional<org.trimou.engine.resolver.MemberWrapper>> notification)

Specified by:

onRemoval in interface com.google.common.cache.RemovalListener<org.trimou.engine.resolver.MemberKey,com.google.common.base.Optional<org.trimou.engine.resolver.MemberWrapper>>

invalidateMemberCache

public void invalidateMemberCache(com.google.common.base.Predicate<java.lang.Class<?>> predicate)

The member cache may theoretically cause memory leaks due to using hard references to Class and Member instances. As a temporary workaround we provide a way to invalidate the cache or some of its entries (e.g. for a concrete classloader).

Parameters:

predicate - If null, all cache entries are discarded, otherwise an entry is only discarded if the given predicate returns true for the Object.getClass()