org.trimou.engine.resolver

Interface Resolver

All Superinterfaces:

ConfigurationAware, WithPriority

All Known Subinterfaces:

EnhancedResolver

All Known Implementing Classes:

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

public interface Resolver
extends WithPriority, ConfigurationAware

A value resolver. Implementations must be thread-safe.

Any resolver may implement optional interface Validateable. The validation is performed before a MustacheEngine is built. An invalid resolver is not put into service, i.e. it's not included in the final list of resolvers returned by Configuration.getResolvers().

Author:

Martin Kouba

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PRIORITY

Method Summary

Modifier and Type	Method and Description
default int	getPriority()
Object	resolve(Object contextObject, String name, ResolutionContext context) Resolve the value from specified context object and name.

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

getConfigurationKeys, init

Field Detail

DEFAULT_PRIORITY

static final int DEFAULT_PRIORITY

See Also:

Constant Field Values

Method Detail

resolve

Object resolve(Object contextObject,
               String name,
               ResolutionContext context)

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.

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

See Also:

Placeholder.NULL

getPriority

default int getPriority()

Specified by:

getPriority in interface WithPriority

Returns:

the priority value