org.trimou.engine

Class MustacheEngineBuilder

java.lang.Object

org.trimou.engine.MustacheEngineBuilder

All Implemented Interfaces:

ConfigurationExtension.ConfigurationExtensionBuilder

public final class MustacheEngineBuilder
extends Object
implements ConfigurationExtension.ConfigurationExtensionBuilder

A builder for MustacheEngine. It's not thread-safe. The builder is considered immutable once the build() method is called. Subsequent invocations of any modifying method or build() result in an IllegalStateException.

Note that most ConfigurationAware components are tied to the specific engine instance and cannot be reused as well.

Author:

Martin Kouba

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MustacheEngineBuilder.EngineBuiltCallback

Method Summary

Modifier and Type	Method and Description
MustacheEngineBuilder	addGlobalData(String name, Object value) Adds a value (e.g.
MustacheEngineBuilder	addMustacheListener(MustacheListener listener) Adds a Mustache listener.
MustacheEngineBuilder	addResolver(Resolver resolver) Adds a value resolver.
MustacheEngineBuilder	addTemplateLocator(TemplateLocator locator) Adds a template locator.
MustacheEngineBuilder	addValueConverter(ValueConverter converter) Add a value converter.
MustacheEngine	build() Builds the engine instance.
Map<String,Object>	buildGlobalData()
Map<String,Helper>	buildHelpers()
List<MustacheListener>	buildMustacheListeners()
Map<String,Object>	buildProperties()
Set<Resolver>	buildResolvers()
Set<TemplateLocator>	buildTemplateLocators()
Set<ValueConverter>	buildValueConverters()
ComputingCacheFactory	getComputingCacheFactory()
ClassLoader	getConfigurationExtensionClassLoader()
ExecutorService	getExecutorService()
IdentifierGenerator	getIdentifierGenerator()
KeySplitter	getKeySplitter()
LiteralSupport	getLiteralSupport()
LocaleSupport	getLocaleSupport()
MissingValueHandler	getMissingValueHandler()
TextSupport	getTextSupport()
boolean	isOmitServiceLoaderConfigurationExtensions()
static MustacheEngineBuilder	newBuilder()
MustacheEngineBuilder	omitServiceLoaderConfigurationExtensions() Don't use the ServiceLoader mechanism to load configuration extensions (i.e. the default resolvers are not added automatically).
MustacheEngineBuilder	registerCallback(MustacheEngineBuilder.EngineBuiltCallback callback) Callback is useful to configure a component instantiated before the engine is built.
MustacheEngineBuilder	registerHelper(String name, Helper helper) Each helper must be registered with a unique name.
MustacheEngineBuilder	registerHelper(String name, Helper helper, boolean overwrite) Each helper must be registered with a unique name.
MustacheEngineBuilder	registerHelpers(Map<String,Helper> helpers) Each helper must be registered with a unique name.
MustacheEngineBuilder	registerHelpers(Map<String,Helper> helpers, boolean overwrite) Each helper must be registered with a unique name.
MustacheEngineBuilder	setComputingCacheFactory(ComputingCacheFactory cacheFactory) Set the custom ComputingCacheFactory.
MustacheEngineBuilder	setConfigurationExtensionClassLoader(ClassLoader configurationExtensionClassLoader) Set the ClassLoader used to load ConfigurationExtensions.
MustacheEngineBuilder	setExecutorService(ExecutorService executorService) Set the ExecutorService to be used for async tasks.
MustacheEngineBuilder	setIdentifierGenerator(IdentifierGenerator identifierGenerator) Set the custom IdentifierGenerator.
MustacheEngineBuilder	setKeySplitter(KeySplitter keySplitter)
MustacheEngineBuilder	setLiteralSupport(LiteralSupport literalSupport) Set the custom LiteralSupport.
MustacheEngineBuilder	setLocaleSupport(LocaleSupport localeSupport) Sets a locale support instance.
MustacheEngineBuilder	setMissingValueHandler(MissingValueHandler missingValueHandler)
MustacheEngineBuilder	setProperty(String key, Object value) Sets a configuration property.
<T extends ConfigurationKey> MustacheEngineBuilder	setProperty(T configurationKey, 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.

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.

Specified by:

addGlobalData in interface ConfigurationExtension.ConfigurationExtensionBuilder

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 value resolver.

Specified by:

addResolver in interface ConfigurationExtension.ConfigurationExtensionBuilder

Parameters:

resolver -

Returns:

self

setProperty

public MustacheEngineBuilder setProperty(String key,
                                         Object value)

Sets a configuration property.

Parameters:

key -

value -

Returns:

self

setProperty

public <T extends ConfigurationKey> MustacheEngineBuilder setProperty(T configurationKey,
                                                                      Object value)

Sets a configuration property.

Type Parameters:

T - The type of configuration key

Parameters:

configurationKey -

value -

Returns:

self

setTextSupport

public MustacheEngineBuilder setTextSupport(TextSupport textSupport)

Sets a text support instance.

Parameters:

textSupport -

Returns:

self

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

addMustacheListener

public MustacheEngineBuilder addMustacheListener(MustacheListener listener)

Adds a Mustache listener. Manually added listeners are always registered before listeners added via configuration extensions.

Specified by:

addMustacheListener in interface ConfigurationExtension.ConfigurationExtensionBuilder

Parameters:

listener -

Returns:

self

setKeySplitter

public MustacheEngineBuilder setKeySplitter(KeySplitter keySplitter)

Parameters:

keySplitter -

Returns:

self

setMissingValueHandler

public MustacheEngineBuilder setMissingValueHandler(MissingValueHandler missingValueHandler)

Parameters:

missingValueHandler -

Returns:

self

registerHelper

public MustacheEngineBuilder registerHelper(String name,
                                            Helper helper)

Each helper must be registered with a unique name. If there are more helpers registered with the same name an IllegalArgumentException is thrown. Use registerHelper(String, Helper, boolean) to overwrite the helper.

Specified by:

registerHelper in interface ConfigurationExtension.ConfigurationExtensionBuilder

Parameters:

name -

helper -

Returns:

self

See Also:

ConfigurationExtensions#registerHelper(ConfigurationExtensionBuilder, String, Helper)

registerHelper

public MustacheEngineBuilder registerHelper(String name,
                                            Helper helper,
                                            boolean overwrite)

Each helper must be registered with a unique name. If there is a helper registered with the same name and the param overwrite is true the previous instance is replaced, otherwise an IllegalArgumentException is thrown.

Specified by:

registerHelper in interface ConfigurationExtension.ConfigurationExtensionBuilder

Parameters:

name -

helper -

overwrite -

Returns:

self

registerHelpers

public MustacheEngineBuilder registerHelpers(Map<String,Helper> helpers)

Each helper must be registered with a unique name. If there are more helpers registered with the same name an IllegalArgumentException is thrown. Use registerHelpers(Map, boolean) to overwrite the helpers.

Specified by:

registerHelpers in interface ConfigurationExtension.ConfigurationExtensionBuilder

Parameters:

helpers -

Returns:

self

See Also:

ConfigurationExtensions#registerHelpers(ConfigurationExtensionBuilder, Map)

registerHelpers

public MustacheEngineBuilder registerHelpers(Map<String,Helper> helpers,
                                             boolean overwrite)

Each helper must be registered with a unique name. If there is a helper registered with the same name and the param overwrite is true the previous instance is replaced, otherwise an IllegalArgumentException is thrown.

Specified by:

registerHelpers in interface ConfigurationExtension.ConfigurationExtensionBuilder

Parameters:

helpers -

overwrite -

Returns:

omitServiceLoaderConfigurationExtensions

public MustacheEngineBuilder omitServiceLoaderConfigurationExtensions()

Don't use the ServiceLoader mechanism to load configuration extensions (i.e. the default resolvers are not added automatically).

See Also:

ConfigurationExtension

setComputingCacheFactory

public MustacheEngineBuilder setComputingCacheFactory(ComputingCacheFactory cacheFactory)

Set the custom ComputingCacheFactory.

Parameters:

cacheFactory -

Returns:

self

setIdentifierGenerator

public MustacheEngineBuilder setIdentifierGenerator(IdentifierGenerator identifierGenerator)

Set the custom IdentifierGenerator.

Parameters:

identifierGenerator -

Returns:

self

setExecutorService

public MustacheEngineBuilder setExecutorService(ExecutorService executorService)

Set the ExecutorService to be used for async tasks.

Parameters:

executorService -

Returns:

self

setLiteralSupport

public MustacheEngineBuilder setLiteralSupport(LiteralSupport literalSupport)

Set the custom LiteralSupport.

Parameters:

literalSupport -

Returns:

self

setConfigurationExtensionClassLoader

public MustacheEngineBuilder setConfigurationExtensionClassLoader(ClassLoader configurationExtensionClassLoader)

Set the ClassLoader used to load ConfigurationExtensions.

Parameters:

configurationExtensionClassLoader -

Returns:

self

addValueConverter

public MustacheEngineBuilder addValueConverter(ValueConverter converter)

Add a value converter.

Specified by:

addValueConverter in interface ConfigurationExtension.ConfigurationExtensionBuilder

Parameters:

converter -

Returns:

self

newBuilder

public static MustacheEngineBuilder newBuilder()

Returns:

a new instance of builder

buildTemplateLocators

public Set<TemplateLocator> buildTemplateLocators()

buildResolvers

public Set<Resolver> buildResolvers()

buildGlobalData

public Map<String,Object> buildGlobalData()

getTextSupport

public TextSupport getTextSupport()

getLocaleSupport

public LocaleSupport getLocaleSupport()

isOmitServiceLoaderConfigurationExtensions

public boolean isOmitServiceLoaderConfigurationExtensions()

buildProperties

public Map<String,Object> buildProperties()

buildMustacheListeners

public List<MustacheListener> buildMustacheListeners()

getKeySplitter

public KeySplitter getKeySplitter()

getMissingValueHandler

public MissingValueHandler getMissingValueHandler()

buildHelpers

public Map<String,Helper> buildHelpers()

getComputingCacheFactory

public ComputingCacheFactory getComputingCacheFactory()

getIdentifierGenerator

public IdentifierGenerator getIdentifierGenerator()

getExecutorService

public ExecutorService getExecutorService()

getLiteralSupport

public LiteralSupport getLiteralSupport()

getConfigurationExtensionClassLoader

public ClassLoader getConfigurationExtensionClassLoader()

buildValueConverters

public Set<ValueConverter> buildValueConverters()