org.trimou.engine.resolver

Interface EnhancedResolver

All Superinterfaces:

ConfigurationAware, Resolver, WithPriority

All Known Implementing Classes:

AbstractResolver, ArrayIndexResolver, CombinedIndexResolver, DateTimeFormatResolver, DummyTransformResolver, IndexResolver, ListIndexResolver, LocaleAwareResolver, MapCustomKeyResolver, MapResolver, NumberFormatResolver, ReflectionResolver, ResourceBundleResolver, ThisResolver, TransformResolver

public interface EnhancedResolver
extends Resolver

An enhanced resolver should be able to create a EnhancedResolver.Hint for a sucessfully resolved context object and name.

Note that hints may not always give better results. E.g. if we have a tag {{foo.bar}} and first we pass data where foo is resolved as a map and then another data where foo is resolved as an integer, the hint created for the map will not work for integer. In this case, the hint should inform that it's not applicable and the resolver chain will be used to resolve the value.

EngineConfigurationKey.RESOLVER_HINTS_ENABLED can be used to disable the hints entirely.

Author:

Martin Kouba

See Also:

EngineConfigurationKey.RESOLVER_HINTS_ENABLED

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	EnhancedResolver.Hint A hint could be used to skip the resolver chain for a part of the key of a specific tag.

Field Summary

Fields inherited from interface org.trimou.engine.resolver.Resolver

DEFAULT_PRIORITY

Method Summary

Modifier and Type	Method and Description
EnhancedResolver.Hint	createHint(Object contextObject, String name, ResolutionContext context) This method may only be called right after the Resolver.resolve(Object, String, ResolutionContext) of the same resolver returns a non-null value.

Methods inherited from interface org.trimou.engine.resolver.Resolver

getPriority, resolve

Methods inherited from interface org.trimou.engine.config.ConfigurationAware

getConfigurationKeys, init

Method Detail

createHint

EnhancedResolver.Hint createHint(Object contextObject,
                                 String name,
                                 ResolutionContext context)

This method may only be called right after the Resolver.resolve(Object, String, ResolutionContext) of the same resolver returns a non-null value. The parameters must be the same.

The created hint is currently only used to skip the resolver chain for the first part of a key of a variable tag, i.e. foo for {{foo}} or {{foo.bar}}.

This method must not return null.

Parameters:

contextObject -

name -

context -

Returns:

the hint

See Also:

Hints.INAPPLICABLE_HINT