MustacheEngineBuilder (trimou-core 1.7.2.Final API)

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 until build() method is called - the builder is considered immutable afterwards and subsequent invocations of any modifying method or build() results in IllegalStateException. Thus it's not reusable.

Author:

Martin Kouba

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface MustacheEngineBuilder.EngineBuiltCallback

Nested Classes
Modifier and Type	Class and Description
`static interface`	`MustacheEngineBuilder.EngineBuiltCallback`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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.
`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()`
`ComputingCacheFactory`	`getComputingCacheFactory()`
`IdentifierGenerator`	`getIdentifierGenerator()`
`KeySplitter`	`getKeySplitter()`
`LocaleSupport`	`getLocaleSupport()`
`MissingValueHandler`	`getMissingValueHandler()`
`TextSupport`	`getTextSupport()`
`boolean`	`isOmitServiceLoaderConfigurationExtensions()`
`static MustacheEngineBuilder`	`newBuilder()`
`MustacheEngineBuilder`	`omitServiceLoaderConfigurationExtensions()` Don't use the ServiceLoader mechanism to load configuration extensions.
`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`	`registerHelpers(Map<String,Helper> helpers)` Each helper must be registered with a unique name.
`MustacheEngineBuilder`	`setComputingCacheFactory(ComputingCacheFactory cacheFactory)` Set the custom `ComputingCacheFactory`.
`MustacheEngineBuilder`	`setIdentifierGenerator(IdentifierGenerator identifierGenerator)` Set the custom `IdentifierGenerator`.
`MustacheEngineBuilder`	`setKeySplitter(KeySplitter keySplitter)`
`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 during build().
    
    Specified by:
    
    registerHelper in interface ConfigurationExtension.ConfigurationExtensionBuilder
    
    Parameters:
    
    name -
    
    helper -
    
    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 during build().
    
    Specified by:
    
    registerHelpers in interface ConfigurationExtension.ConfigurationExtensionBuilder
    
    Parameters:
    
    helpers -
    
    Returns:
    
    self
  - omitServiceLoaderConfigurationExtensions
```
public MustacheEngineBuilder omitServiceLoaderConfigurationExtensions()
```
    Don't use the ServiceLoader mechanism to load configuration extensions.
    
    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
  - newBuilder
```
public static MustacheEngineBuilder newBuilder()
```
    Returns:
    
    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()
```

Class MustacheEngineBuilder

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

build

addGlobalData

addTemplateLocator

addResolver

setProperty

setProperty

setTextSupport

setLocaleSupport

registerCallback

addMustacheListener

setKeySplitter

setMissingValueHandler

registerHelper

registerHelpers

omitServiceLoaderConfigurationExtensions

setComputingCacheFactory

setIdentifierGenerator

newBuilder

buildTemplateLocators

buildResolvers

buildGlobalData

getTextSupport

getLocaleSupport

isOmitServiceLoaderConfigurationExtensions

buildProperties

buildMustacheListeners

getKeySplitter

getMissingValueHandler

buildHelpers

getComputingCacheFactory

getIdentifierGenerator