com.mitchellbosecke.pebble

Class PebbleEngine

java.lang.Object

com.mitchellbosecke.pebble.PebbleEngine

public class PebbleEngine
extends Object

The main class used for compiling templates. The PebbleEngine is responsible for delegating responsibility to the lexer, parser, compiler, and template cache.

Author:

Mitchell

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PebbleEngine.Builder A builder to configure and construct an instance of a PebbleEngine.

Method Summary

Modifier and Type	Method and Description
Locale	getDefaultLocale() Returns the default locale
EvaluationOptions	getEvaluationOptions()
ExecutorService	getExecutorService() Returns the executor service
ExtensionRegistry	getExtensionRegistry() Returns the extension registry.
PebbleTemplate	getLiteralTemplate(String templateName) Loads, parses, and compiles a template using a StringLoader into an instance of PebbleTemplate and returns this instance.
Loader<?>	getLoader() Returns the loader
Syntax	getSyntax() Returns the syntax which is used by this PebbleEngine.
PebbleCache<CacheKey,Object>	getTagCache() Returns the tag cache
PebbleTemplate	getTemplate(String templateName) Loads, parses, and compiles a template into an instance of PebbleTemplate and returns this instance.
PebbleCache<Object,PebbleTemplate>	getTemplateCache() Returns the template cache
boolean	isStrictVariables() Returns the strict variables setting

Methods inherited from class java.lang.Object

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

Method Detail

getTemplate

public PebbleTemplate getTemplate(String templateName)

Loads, parses, and compiles a template into an instance of PebbleTemplate and returns this instance.

Parameters:

templateName - The name of the template

Returns:

PebbleTemplate The compiled version of the template

getLiteralTemplate

public PebbleTemplate getLiteralTemplate(String templateName)

Loads, parses, and compiles a template using a StringLoader into an instance of PebbleTemplate and returns this instance.

Parameters:

templateName - The name of the template

Returns:

PebbleTemplate The compiled version of the template

getLoader

public Loader<?> getLoader()

Returns the loader

Returns:

The loader

getTemplateCache

public PebbleCache<Object,PebbleTemplate> getTemplateCache()

Returns the template cache

Returns:

The template cache

isStrictVariables

public boolean isStrictVariables()

Returns the strict variables setting

Returns:

The strict variables setting

getDefaultLocale

public Locale getDefaultLocale()

Returns the default locale

Returns:

The default locale

getExecutorService

public ExecutorService getExecutorService()

Returns the executor service

Returns:

The executor service

getSyntax

public Syntax getSyntax()

Returns the syntax which is used by this PebbleEngine.

Returns:

the syntax used by the PebbleEngine.

getExtensionRegistry

public ExtensionRegistry getExtensionRegistry()

Returns the extension registry.

Returns:

The extension registry

getTagCache

public PebbleCache<CacheKey,Object> getTagCache()

Returns the tag cache

Returns:

The tag cache

getEvaluationOptions

public EvaluationOptions getEvaluationOptions()