org.trimou.engine.resolver

Class CombinedIndexResolver

java.lang.Object

org.trimou.engine.config.AbstractConfigurationAware

org.trimou.engine.resolver.AbstractResolver

org.trimou.engine.resolver.IndexResolver

org.trimou.engine.resolver.CombinedIndexResolver

All Implemented Interfaces:

ConfigurationAware, WithPriority, EnhancedResolver, Resolver, Validateable

public class CombinedIndexResolver
extends IndexResolver
implements Validateable

A combined resolver which is able to resolve index-based access to lists and arrays.

Author:

Martin Kouba

See Also:

IndexResolver, ListIndexResolver, ArrayIndexResolver

Nested Class Summary

Nested classes/interfaces inherited from interface org.trimou.engine.resolver.EnhancedResolver

EnhancedResolver.Hint

Field Summary

Fields

Modifier and Type	Field and Description
static ConfigurationKey	ENABLED_KEY If set to false the resolver is marked as invalid.

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

configuration

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
CombinedIndexResolver()
CombinedIndexResolver(int priority)

Method Summary

Modifier and Type	Method and Description
Set<ConfigurationKey>	getConfigurationKeys()
void	init(Configuration configuration) Initialize the component.
boolean	isValid()
Object	resolve(Object contextObject, String name, ResolutionContext context) Resolve the value from specified context object and name.

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

getIndexValue, getIndexValue, isAnIndex, notAnIndex

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

createHint, getPriority, toString

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

checkNotInitialized, init

Methods inherited from class java.lang.Object

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

Field Detail

ENABLED_KEY

public static final ConfigurationKey ENABLED_KEY

If set to false the resolver is marked as invalid.

Constructor Detail

CombinedIndexResolver

public CombinedIndexResolver()

CombinedIndexResolver

public CombinedIndexResolver(int priority)

Parameters:

priority -

Method Detail

resolve

public Object resolve(Object contextObject,
                      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 Set<ConfigurationKey> getConfigurationKeys()

Specified by:

getConfigurationKeys in interface ConfigurationAware

Overrides:

getConfigurationKeys in class AbstractConfigurationAware

Returns:

the set of configuration keys to discover

isValid

public boolean isValid()

Specified by:

isValid in interface Validateable

Returns:

true if valid, false otherwise