org.trimou.engine

Class MustacheEngineBuilder

java.lang.Object

org.trimou.engine.MustacheEngineBuilder

public class MustacheEngineBuilder
extends Object

Builds a MustacheEngine instance.

Author:

Martin Kouba

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MustacheEngineBuilder.EngineBuiltCallback

Method Summary

Methods

Modifier and Type	Method and Description
MustacheEngineBuilder	addGlobalData(String name, Object value) Adds a value (e.g.
MustacheEngineBuilder	addResolver(Resolver resolver) Adds a context object resolver.
MustacheEngineBuilder	addTemplateLocator(TemplateLocator locator) Adds a template locator.
MustacheEngine	build() Builds the engine instance.
Map<String,Object>	getGlobalData()
LocaleSupport	getLocaleSupport()
Map<String,Object>	getProperties()
Set<Resolver>	getResolvers()
Set<TemplateLocator>	getTemplateLocators()
TextSupport	getTextSupport()
boolean	isOmitServiceLoaderResolvers()
static MustacheEngineBuilder	newBuilder()
MustacheEngineBuilder	omitServiceLoaderResolvers() Don't use the ServiceLoader mechanism to load resolvers.
MustacheEngineBuilder	registerCallback(MustacheEngineBuilder.EngineBuiltCallback callback) Callback is useful to configure a component instantiated before the engine is built.
MustacheEngineBuilder	setLocaleSupport(LocaleSupport localeSupport) Sets a locale support instance.
MustacheEngineBuilder	setProperty(ConfigurationKey configurationKey, Object value) Sets a configuration property.
MustacheEngineBuilder	setProperty(String key, Object value) Sets a configuration property.
MustacheEngineBuilder	setTextSupport(TextSupport textSupport) Sets a text support instance.

Methods inherited from class java.lang.Object

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

Method Detail

build

public MustacheEngine build()

Builds the engine instance. The builder cleanup is performed after the engine is built.

Returns:

the built engine

addGlobalData

public MustacheEngineBuilder addGlobalData(String name,
                                  Object value)

Adds a value (e.g. Lambda) that is available during execution of all templates. Global values have to be thread-safe.

Parameters:

value -

name -

Returns:

self

addTemplateLocator

public MustacheEngineBuilder addTemplateLocator(TemplateLocator locator)

Adds a template locator.

Parameters:

locator -

Returns:

self

addResolver

public MustacheEngineBuilder addResolver(Resolver resolver)

Adds a context object resolver.

Parameters:

resolver -

Returns:

self

setProperty

public MustacheEngineBuilder setProperty(String key,
                                Object value)

Sets a configuration property.

Parameters:

key -

value -

Returns:

self

setProperty

public MustacheEngineBuilder setProperty(ConfigurationKey configurationKey,
                                Object value)

Sets a configuration property.

Parameters:

configurationKey -

value -

Returns:

self

setTextSupport

public MustacheEngineBuilder setTextSupport(TextSupport textSupport)

Sets a text support instance.

Parameters:

textSupport -

Returns:

selg

setLocaleSupport

public MustacheEngineBuilder setLocaleSupport(LocaleSupport localeSupport)

Sets a locale support instance.

Parameters:

localeSupport -

Returns:

self

registerCallback

public MustacheEngineBuilder registerCallback(MustacheEngineBuilder.EngineBuiltCallback callback)

Callback is useful to configure a component instantiated before the engine is built.

Parameters:

callback -

Returns:

self

omitServiceLoaderResolvers

public MustacheEngineBuilder omitServiceLoaderResolvers()

Don't use the ServiceLoader mechanism to load resolvers.

newBuilder

public static MustacheEngineBuilder newBuilder()

Returns:

new instance of builder

getTemplateLocators

public Set<TemplateLocator> getTemplateLocators()

getResolvers

public Set<Resolver> getResolvers()

getGlobalData

public Map<String,Object> getGlobalData()

getTextSupport

public TextSupport getTextSupport()

getLocaleSupport

public LocaleSupport getLocaleSupport()

isOmitServiceLoaderResolvers

public boolean isOmitServiceLoaderResolvers()

getProperties

public Map<String,Object> getProperties()