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

Constructor Summary

Constructors

Constructor and Description
PebbleEngine()
PebbleEngine(Loader loader) Constructor for the Pebble Engine given an instantiated Loader.

Method Summary

Modifier and Type	Method and Description
void	addExtension(Extension extension)
Map<String,BinaryOperator>	getBinaryOperators()
Locale	getDefaultLocale()
ExecutorService	getExecutorService()
<T extends Extension> T	getExtension(Class<T> clazz)
Map<String,Filter>	getFilters()
Map<String,Function>	getFunctions()
Map<String,Object>	getGlobalVariables()
Lexer	getLexer()
Loader	getLoader()
List<NodeVisitor>	getNodeVisitors()
Parser	getParser()
PebbleTemplate	getTemplate(String templateName) Loads, parses, and compiles a template into an instance of PebbleTemplate and returns this instance.
com.google.common.cache.Cache<String,PebbleTemplate>	getTemplateCache()
Map<String,Test>	getTests()
Map<String,TokenParser>	getTokenParsers()
Map<String,UnaryOperator>	getUnaryOperators()
boolean	isStrictVariables()
void	setDefaultLocale(Locale locale) The default locale that will be passed to each template upon compilation.
void	setExecutorService(ExecutorService executorService) Providing an ExecutorService will enable some advanced multithreading features such as the parallel tag.
void	setLoader(Loader loader)
void	setStrictVariables(boolean strictVariables) Changes the strictVariables setting of the PebbleEngine.
void	setTemplateCache(com.google.common.cache.Cache<String,PebbleTemplate> cache) Sets the cache to be used for storing compiled PebbleTemplate instances.

Methods inherited from class java.lang.Object

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

Constructor Detail

PebbleEngine

public PebbleEngine()

PebbleEngine

public PebbleEngine(Loader loader)

Constructor for the Pebble Engine given an instantiated Loader.

Parameters:

loader - The template loader for this engine

Method Detail

getTemplate

public PebbleTemplate getTemplate(String templateName)
                           throws PebbleException

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

Throws:

PebbleException - Thrown if an error occurs while parsing the template.

setLoader

public void setLoader(Loader loader)

getLoader

public Loader getLoader()

getParser

public Parser getParser()

getLexer

public Lexer getLexer()

addExtension

public void addExtension(Extension extension)

getExtension

public <T extends Extension> T getExtension(Class<T> clazz)

getTokenParsers

public Map<String,TokenParser> getTokenParsers()

getBinaryOperators

public Map<String,BinaryOperator> getBinaryOperators()

getUnaryOperators

public Map<String,UnaryOperator> getUnaryOperators()

getFilters

public Map<String,Filter> getFilters()

getTests

public Map<String,Test> getTests()

getFunctions

public Map<String,Function> getFunctions()

getGlobalVariables

public Map<String,Object> getGlobalVariables()

getNodeVisitors

public List<NodeVisitor> getNodeVisitors()

getTemplateCache

public com.google.common.cache.Cache<String,PebbleTemplate> getTemplateCache()

setTemplateCache

public void setTemplateCache(com.google.common.cache.Cache<String,PebbleTemplate> cache)

Sets the cache to be used for storing compiled PebbleTemplate instances.

Parameters:

cache - The cache to be used

isStrictVariables

public boolean isStrictVariables()

setStrictVariables

public void setStrictVariables(boolean strictVariables)

Changes the strictVariables setting of the PebbleEngine. If strictVariables is equal to false (which is the default) then expressions become much more null-safe and type issues are handled in a much more graceful manner.

Parameters:

strictVariables - Whether or not strict variables is used

getDefaultLocale

public Locale getDefaultLocale()

setDefaultLocale

public void setDefaultLocale(Locale locale)

The default locale that will be passed to each template upon compilation. An individual template can be given a new locale on evaluation.

Parameters:

locale - The default locale to pass to all newly compiled templates.

getExecutorService

public ExecutorService getExecutorService()

setExecutorService

public void setExecutorService(ExecutorService executorService)

Providing an ExecutorService will enable some advanced multithreading features such as the parallel tag.

Parameters:

executorService - The ExecutorService to enable multithreading features.