org.trimou.engine.convert

Class DecoratorConverter<T>

java.lang.Object

org.trimou.engine.config.AbstractConfigurationAware

org.trimou.engine.convert.DecoratorConverter<T>

All Implemented Interfaces:

ConfigurationAware, ContextConverter, Converter<Object,Object>, WithPriority, Validateable

public class DecoratorConverter<T>
extends AbstractConfigurationAware
implements ContextConverter

This converter allows you to decorate a context object, e.g. to add a computed property. The following snippet would render: "ooF".

 MustacheEngine engine = MustacheEngineBuilder.newBuilder()
         .addContextConverter(
                 decorate(String.class).compute("reverse", s -> new StringBuilder(s).reverse().toString()).build())
         .build();
 engine.compileMustache("{{reverse}}").render("Foo");
 

By default, the converter is applied if the runtime class of the context object is assignable to the delegate type. A custom predicate can be used but beware of generics pitfalls and ClassCastExceptions.

Note that ReflectionResolver and MapResolver must be registered in order to make it work.

Author:

Martin Kouba

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DecoratorConverter.Builder<T>

Field Summary

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

configuration

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

DEFAULT_PRIORITY

Method Summary

Modifier and Type	Method and Description
Object	convert(Object from)
static <T> DecoratorConverter.Builder<T>	decorate(Class<T> delegateType) Returns a decorator converter builder for the specified delegate type.
static <T> DecoratorConverter.Builder<T>	decorate(Predicate<Object> test) Returns a decorator converter builder with the specified predicate used to test a context object.

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

checkNotInitialized, init, init

Methods inherited from class java.lang.Object

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

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

getPriority

Methods inherited from interface org.trimou.engine.validation.Validateable

isValid

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

getConfigurationKeys, init

Method Detail

decorate

public static <T> DecoratorConverter.Builder<T> decorate(Class<T> delegateType)

Returns a decorator converter builder for the specified delegate type.

Parameters:

delegateType -

Returns:

a new builder instance

decorate

public static <T> DecoratorConverter.Builder<T> decorate(Predicate<Object> test)

Returns a decorator converter builder with the specified predicate used to test a context object.

Parameters:

delegateType -

Returns:

a new builder instance

convert

public Object convert(Object from)

Specified by:

convert in interface Converter<Object,Object>

Returns:

the converted object or null if it's not possible to convert the object